[PATCH 2/3] xfsprogs: Fix manpages for missing or incorrect options

Rich Johnston rjohnston at sgi.com
Tue Apr 23 13:35:23 CDT 2013


Hey Eric,

Couple of comments.

1. The OPTIONS are listed in several ways, (alphabetical order, same 
order as they appear in the SYNOPSIS, ...).  I don't really have a 
preference, but as long as we are cleaning up the manpages, I suggest we 
be consistent. (case insensitive alpha order maybe???)

2. How about making the -V option wording the same also?
	xfs_db and xfs_repair are:
    		Prints out the current version number and exits.
			       ^^^^^^^^
	The others:
	man/man8/mkfs.xfs.8:Prints the version number and exits.
	man/man8/xfs_admin.8:Prints the version number and exits.
	man/man8/xfs_bmap.8:Prints the version number and exits.
	man/man8/xfs_check.8:Prints the version number and exits.
	man/man8/xfs_copy.8:Prints the version number and exits.
	man/man8/xfs_growfs.8:Prints the version number and exits. The
	man/man8/xfs_io.8:Prints the version number and exits.
	man/man8/xfs_logprint.8:Prints the version number and exits.
	man/man8/xfs_mkfile.8:Prints the version number and exits.
	man/man8/xfs_ncheck.8:Prints the version number and exits.
	man/man8/xfs_rtcp.8:Prints the version number and exits.

3. The following are missing the -V option in both the SYNOPSIS and 
OPTIONS sections.
(I did verify the -V option works for all commands)
man/man8/xfs_estimate.8
man/man8/xfs_freeze.8
man/man8/xfs_fsr.8
man/man8/xfs_mdrestore.8
man/man8/xfs_metadump.8
man/man8/xfs_quota.8
man/man8/xfs_repair.8


4. The -V prints the version and exits, shouldn't all the SYNOPSIS look 
like this for the -V option?

SYNOPSIS
        xfs_db [ -c cmd ] ... [ -i|r|x|F ] [ -f ] [ -l logdev ] ...
        xfs_db -V

Regards
--Rich



More information about the xfs mailing list