xfs
[Top] [All Lists]

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

To: Eric Sandeen <sandeen@xxxxxxxxxxx>
Subject: Re: [PATCH 2/3] xfsprogs: Fix manpages for missing or incorrect options
From: Rich Johnston <rjohnston@xxxxxxx>
Date: Tue, 23 Apr 2013 13:35:23 -0500
Cc: xfs-oss <xfs@xxxxxxxxxxx>
Delivered-to: xfs@xxxxxxxxxxx
In-reply-to: <5175BC67.1000902@xxxxxxxxxxx>
References: <5175BB8F.5090604@xxxxxxxxxxx> <5175BC67.1000902@xxxxxxxxxxx>
User-agent: Mozilla/5.0 (X11; Linux i686; rv:13.0) Gecko/20120615 Thunderbird/13.0.1
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

<Prev in Thread] Current Thread [Next in Thread>