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 14:45:50 -0500
Cc: xfs-oss <xfs@xxxxxxxxxxx>
Delivered-to: xfs@xxxxxxxxxxx
In-reply-to: <5176E2AF.7080201@xxxxxxxxxxx>
References: <5175BB8F.5090604@xxxxxxxxxxx> <5175BC67.1000902@xxxxxxxxxxx> <5176D46B.2030003@xxxxxxx> <5176E2AF.7080201@xxxxxxxxxxx>
User-agent: Mozilla/5.0 (X11; Linux i686; rv:13.0) Gecko/20120615 Thunderbird/13.0.1
On 04/23/2013 02:36 PM, Eric Sandeen wrote:
On 4/23/13 1:35 PM, Rich Johnston wrote:
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???)

That'd make a fine followup patch, I agree! ;)  Re-ordering every
manpage won't really be on my todo list soon, though.

Sounds good.
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.
                    ^^^^^^^^

I suppose.  I'm not really sure anyone would care?

Not important just noting it ;)

     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

not sure how I missed those, sorry.
Do you have time to add these?  This really the only todo for now I think.



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

Probably.  -V is least important of the fixes; I'd be more inclined to just drop
the -V changes and not spend a couple more hours rearranging manpages.

This was fine work on a plane, but there are more pressing things to do now :(
Agreed


Maybe some list-reader who wants some changelog glory could take this further?  
:)

Yes a follow up patch works for me, any volunteers?

-Eric

Regards
--Rich

_______________________________________________
xfs mailing list
xfs@xxxxxxxxxxx
http://oss.sgi.com/mailman/listinfo/xfs




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