X-Git-Url: https://git.kernel.dk/?a=blobdiff_plain;f=HOWTO;h=bd5bebfc929fc1a71a09e15dba27c10d43e0a042;hb=808def7036ddfaf6f0ec2f5ecce031fd46ce40ef;hp=3af4ce6b9e75b89a3089c509281f241f5a836baa;hpb=996093bbc416d2d6da56e85c311418b1c958a0b1;p=fio.git

diff --git a/HOWTO b/HOWTO
index 3af4ce6b..bd5bebfc 100644
--- a/HOWTO
+++ b/HOWTO
@@ -346,7 +346,9 @@ size=int	The total size of file io for this job. Fio will run until
 		limited by other options (such as 'runtime', for instance).
 		Unless specific nrfiles and filesize options are given,
 		fio will divide this size between the available files
-		specified by the job.
+		specified by the job. If not set, fio will use the full
+		size of the given files or devices. If the the files
+		do not exist, size must be given.
 
 filesize=int	Individual file sizes. May be a range, in which case fio
 		will select sizes for files at random within the given range
@@ -976,15 +978,16 @@ write_bw_log=str If given, write a bandwidth log of the jobs in this job
 		filename. For this option, the postfix is _bw.log.
 
 write_lat_log=str Same as write_bw_log, except that this option stores io
-		completion latencies instead. If no filename is given
-		with this option, the default filename of "jobname_type.log"
-		is used. Even if the filename is given, fio will still
-		append the type of log. So if one specifies
+		submission, completion, and total latencies instead. If no
+		filename is given with this option, the default filename of
+		"jobname_type.log" is used. Even if the filename is given,
+		fio will still append the type of log. So if one specifies
 
 		write_lat_log=foo
 
-		The actual log names will be foo_clat.log and foo_slat.log.
-		This helps fio_generate_plot fine the logs automatically.
+		The actual log names will be foo_slat.log, foo_slat.log,
+		and foo_lat.log. This helps fio_generate_plot fine the logs
+		automatically.
 
 lockmem=int	Pin down the specified amount of memory with mlock(2). Can
 		potentially be used instead of removing memory or booting
@@ -1008,18 +1011,21 @@ cpuchunks=int	If the job is a CPU cycle eater, split the load into
 disk_util=bool	Generate disk utilization statistics, if the platform
 		supports it. Defaults to on.
 
-disable_clat=bool Disable measurements of completion latency numbers. Useful
+disable_lat=bool Disable measurements of total latency numbers. Useful
 		only for cutting back the number of calls to gettimeofday,
 		as that does impact performance at really high IOPS rates.
 		Note that to really get rid of a large amount of these
 		calls, this option must be used with disable_slat and
 		disable_bw as well.
 
+disable_clat=bool Disable measurements of completion latency numbers. See
+		disable_lat.
+
 disable_slat=bool Disable measurements of submission latency numbers. See
-		disable_clat.
+		disable_slat.
 
 disable_bw=bool	Disable measurements of throughput/bandwidth numbers. See
-		disable_clat.
+		disable_lat.
 
 gtod_reduce=bool Enable all of the gettimeofday() reducing options
 		(disable_clat, disable_slat, disable_bw) plus reduce
@@ -1208,23 +1214,28 @@ For scripted usage where you typically want to generate tables or graphs
 of the results, fio can output the results in a semicolon separated format.
 The format is one long line of values, such as:
 
-client1;0;0;1906777;1090804;1790;0;0;0.000000;0.000000;0;0;0.000000;0.000000;929380;1152890;25.510151%;1078276.333333;128948.113404;0;0;0;0;0;0.000000;0.000000;0;0;0.000000;0.000000;0;0;0.000000%;0.000000;0.000000;100.000000%;0.000000%;324;100.0%;0.0%;0.0%;0.0%;0.0%;0.0%;0.0%;100.0%;0.0%;0.0%;0.0%;0.0%;0.0%
+2; client1;0;0;1906777;1090804;1790;0;0;0.000000;0.000000;0;0;0.000000;0.000000;929380;1152890;25.510151%;1078276.333333;128948.113404;0;0;0;0;0;0.000000;0.000000;0;0;0.000000;0.000000;0;0;0.000000%;0.000000;0.000000;100.000000%;0.000000%;324;100.0%;0.0%;0.0%;0.0%;0.0%;0.0%;0.0%;100.0%;0.0%;0.0%;0.0%;0.0%;0.0%
 ;0.0%;0.0%;0.0%;0.0%;0.0%
 
-To enable terse output, use the --minimal command line option.
+To enable terse output, use the --minimal command line option. The first
+value is the version of the terse output format. If the output has to
+be changed for some reason, this number will be incremented by 1 to
+signify that change.
 
 Split up, the format is as follows:
 
-	jobname, groupid, error
+	version, jobname, groupid, error
 	READ status:
 		KB IO, bandwidth (KB/sec), runtime (msec)
 		Submission latency: min, max, mean, deviation
 		Completion latency: min, max, mean, deviation
+		Total latency: min, max, mean, deviation
 		Bw: min, max, aggregate percentage of total, mean, deviation
 	WRITE status:
 		KB IO, bandwidth (KB/sec), runtime (msec)
 		Submission latency: min, max, mean, deviation
 		Completion latency: min, max, mean, deviation
+		Total latency: min, max, mean, deviation
 		Bw: min, max, aggregate percentage of total, mean, deviation
 	CPU usage: user, system, context switches, major faults, minor faults
 	IO depths: <=1, 2, 4, 8, 16, 32, >=64