[PATCH 0/7] Sync fio(1) man page with HOWTO

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



From: Tomohiro Kusumi <tkusumi@xxxxxxxxxx>

The man page hasn't been in sync with many of the updates made for
HOWTO. These commits update the man page based on what HOWTO has,
where each commit corresponds to a single section (instead of updating
with commit-to-commit basis). The man page being in sync with HOWTO
also makes it easier to make changes, whenever HOWTO is updated in the
future.

The goal is to be in sync with HOWTO without being too verbose for
a man page. Note that they don't include contents that do not exist
in HOWTO (i.e. I didn't newly create anything). Also note these are
only beginning part of the man page.

These commits include
1. Import updates made only for HOWTO (diffs), unless the changes are
   too long/verbose to be mentioned in the man page.
2. Replace the entire section or paragraph with the corresponding one
   in HOWTO (partly as a result of 1), if these two are essencially
   saying the same thing with small modification, so that we don't see
   two different contents in two documents that are almost the same.
3. Make some small changes when above two are imported, such as using
   directives, removal of double white spaces, removal of expressions
   that don't fit in well with a man page (e.g. This section describes...).
4. Backport some small changes from the man page to HOWTO, which seem
   to have been made when the man page was first introduced. These are
   mostly minor fixups.

Tomohiro Kusumi (7):
  man: sync OPTIONS section with HOWTO
  man: sync "JOB FILE FORMAT" section with HOWTO
  man: sync "JOB FILE PARAMETERS" section with HOWTO
  man: sync "PARAMETER TYPES" section with HOWTO
  man: refer to REPORTING-BUGS for bug reporting
  HOWTO: minor backports from the man page
  HOWTO: fix indentation for options and job parameters

 HOWTO  | 159 +++++++++++++++++++++--------------------
 README |   3 +-
 fio.1  | 250 ++++++++++++++++++++++++++++++++++++++++++++---------------------
 3 files changed, 251 insertions(+), 161 deletions(-)

-- 
2.9.4

--
To unsubscribe from this list: send the line "unsubscribe fio" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Linux Kernel]     [Linux SCSI]     [Linux IDE]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux SCSI]

  Powered by Linux