[PATCH] fio: fix a doc bug(change timeout to runtime)

[PATCH] fio: fix a doc bug(change timeout to runtime)

[liang xie]

From 686c70cc5aacdc5623e4d71e566bbfef7a6abacd Mon Sep 17 00:00:00 2001
From: xieliang <xieliang@xiaomi.com>
Date: Fri, 31 Aug 2012 17:19:57 +0800
Subject: [PATCH 1/1] fio:fix a doc bug(change timeout to runtime)


Signed-off-by: xieliang <xieliang@xiaomi.com>
---
 README |   12 ++++++------
 fio.1  |    4 ++--
 2 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/README b/README
index 8bce835..d19af4b 100644
--- a/README
+++ b/README
@@ -121,7 +121,7 @@ Command line
 $ fio
 	--debug			Enable some debugging options (see below)
 	--output		Write output to file
-	--timeout		Runtime in seconds
+	--runtime		Runtime in seconds
 	--latency-log		Generate per-job latency logs
 	--bandwidth-log		Generate per-job bandwidth logs
 	--minimal		Minimal (terse) output
@@ -138,8 +138,8 @@ $ fio
 				May be "always", "never" or "auto"
 	--section=name		Only run specified section in job file.
 				Multiple sections can be specified.
-	--alloc-size=kb	Set smalloc pool to this size in kb (def 1024)
-	--warnings-fatal Fio parser warnings are fatal
+	--alloc-size=kb		Set smalloc pool to this size in kb (def 1024)
+	--warnings-fatal 	Fio parser warnings are fatal
 	--max-jobs		Maximum number of threads/processes to support
 	--server=args		Start backend server. See Client/Server section.
 	--client=host		Connect to specified backend.
@@ -161,11 +161,11 @@ options in fio. Currently the options are:

 	process		Dump info related to processes
 	file		Dump info related to file actions
-	io			Dump info related to IO queuing
-	mem			Dump info related to memory allocations
+	io		Dump info related to IO queuing
+	mem		Dump info related to memory allocations
 	blktrace	Dump info related to blktrace setup
 	verify		Dump info related to IO verification
-	all			Enable all debug options
+	all		Enable all debug options
 	random		Dump info related to random offset generation
 	parse		Dump info related to option matching and parsing
 	diskutil	Dump info related to disk utilization updates
diff --git a/fio.1 b/fio.1
index 5b61e43..086cf9d 100644
--- a/fio.1
+++ b/fio.1
@@ -20,8 +20,8 @@ list all available tracing options.
 .BI \-\-output \fR=\fPfilename
 Write output to \fIfilename\fR.
 .TP
-.BI \-\-timeout \fR=\fPtimeout
-Limit run time to \fItimeout\fR seconds.
+.BI \-\-runtime \fR=\fPruntime
+Limit run time to \fIruntime\fR seconds.
 .TP
 .B \-\-latency\-log
 Generate per-job latency logs.
-- 
1.7.1

Re: [PATCH] fio: fix a doc bug(change timeout to runtime)

[Jens Axboe]

On 2012-08-31 02:35, liang xie wrote:
> From 686c70cc5aacdc5623e4d71e566bbfef7a6abacd Mon Sep 17 00:00:00 2001
> From: xieliang <xieliang@xiaomi.com>
> Date: Fri, 31 Aug 2012 17:19:57 +0800
> Subject: [PATCH 1/1] fio:fix a doc bug(change timeout to runtime)

Your patch lacks an explanatory changelog message.

> diff --git a/README b/README
> index 8bce835..d19af4b 100644
> --- a/README
> +++ b/README
> @@ -121,7 +121,7 @@ Command line
>  $ fio
>  	--debug			Enable some debugging options (see below)
>  	--output		Write output to file
> -	--timeout		Runtime in seconds
> +	--runtime		Runtime in seconds

They are functionally equivelant.

> @@ -138,8 +138,8 @@ $ fio
>  				May be "always", "never" or "auto"
>  	--section=name		Only run specified section in job file.
>  				Multiple sections can be specified.
> -	--alloc-size=kb	Set smalloc pool to this size in kb (def 1024)
> -	--warnings-fatal Fio parser warnings are fatal
> +	--alloc-size=kb		Set smalloc pool to this size in kb (def 1024)
> +	--warnings-fatal 	Fio parser warnings are fatal
>  	--max-jobs		Maximum number of threads/processes to support
>  	--server=args		Start backend server. See Client/Server section.
>  	--client=host		Connect to specified backend.
> @@ -161,11 +161,11 @@ options in fio. Currently the options are:
> 
>  	process		Dump info related to processes
>  	file		Dump info related to file actions
> -	io			Dump info related to IO queuing
> -	mem			Dump info related to memory allocations
> +	io		Dump info related to IO queuing
> +	mem		Dump info related to memory allocations
>  	blktrace	Dump info related to blktrace setup
>  	verify		Dump info related to IO verification
> -	all			Enable all debug options
> +	all		Enable all debug options
>  	random		Dump info related to random offset generation
>  	parse		Dump info related to option matching and parsing
>  	diskutil	Dump info related to disk utilization updates

Applied these.

> diff --git a/fio.1 b/fio.1
> index 5b61e43..086cf9d 100644
> --- a/fio.1
> +++ b/fio.1
> @@ -20,8 +20,8 @@ list all available tracing options.
>  .BI \-\-output \fR=\fPfilename
>  Write output to \fIfilename\fR.
>  .TP
> -.BI \-\-timeout \fR=\fPtimeout
> -Limit run time to \fItimeout\fR seconds.
> +.BI \-\-runtime \fR=\fPruntime
> +Limit run time to \fIruntime\fR seconds.
>  .TP
>  .B \-\-latency\-log
>  Generate per-job latency logs.

Also equivalant. But it would not hurt to mention both.

-- 
Jens Axboe