All of lore.kernel.org
 help / color / mirror / Atom feed
From: Eric Sandeen <sandeen@sandeen.net>
To: Rich Johnston <rjohnston@sgi.com>
Cc: xfs-oss <xfs@oss.sgi.com>
Subject: Re: [PATCH 2/3] xfsprogs: Fix manpages for missing or incorrect options
Date: Tue, 23 Apr 2013 14:36:15 -0500	[thread overview]
Message-ID: <5176E2AF.7080201@sandeen.net> (raw)
In-Reply-To: <5176D46B.2030003@sgi.com>

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.

> 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?

>     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.

> 
> 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 :(

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

-Eric

> Regards
> --Rich
> 
> _______________________________________________
> xfs mailing list
> xfs@oss.sgi.com
> http://oss.sgi.com/mailman/listinfo/xfs
> 

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

  reply	other threads:[~2013-04-23 19:36 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-04-22 22:37 [PATCH 0/3] xfsprogs: manpage & usage string fixups Eric Sandeen
2013-04-22 22:39 ` [PATCH 1/3] xfsprogs: manpage spelling fixes Eric Sandeen
2013-04-23 15:18   ` Rich Johnston
2013-04-23 15:43     ` Dave Howorth
2013-04-23 15:59       ` Rich Johnston
2013-04-23 16:20         ` Stefan Ring
2013-04-23 19:36     ` Eric Sandeen
2013-04-25 14:12   ` [PATCH 1/3 V2] " Eric Sandeen
2013-04-25 14:59     ` Rich Johnston
2013-04-25 20:43     ` Rich Johnston
2013-04-22 22:40 ` [PATCH 2/3] xfsprogs: Fix manpages for missing or incorrect options Eric Sandeen
2013-04-23 18:35   ` Rich Johnston
2013-04-23 19:36     ` Eric Sandeen [this message]
2013-04-23 19:45       ` Rich Johnston
2013-04-25 15:03   ` [PATCH 2/3 V2] " Eric Sandeen
2013-04-25 15:26     ` Rich Johnston
2013-04-25 15:52     ` Rich Johnston
2013-04-22 22:42 ` [PATCH 3/3] xfsprogs: Fix up usage() errors and omissions Eric Sandeen
2013-04-23 19:37   ` Rich Johnston
2013-04-25 15:16   ` [PATCH 3/3 V2] " Eric Sandeen
2013-04-25 16:13     ` Rich Johnston
2013-04-25 16:15     ` Rich Johnston

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=5176E2AF.7080201@sandeen.net \
    --to=sandeen@sandeen.net \
    --cc=rjohnston@sgi.com \
    --cc=xfs@oss.sgi.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.