linux-lvm.redhat.com archive mirror
 help / color / mirror / Atom feed
From: David Teigland <teigland@redhat.com>
To: Tom Hale <tom@hale.ee>
Cc: linux-lvm@redhat.com
Subject: Re: [linux-lvm] pvscan: bugs in manpage and implementation
Date: Mon, 18 Sep 2017 10:56:13 -0500	[thread overview]
Message-ID: <20170918155613.GA6025@redhat.com> (raw)
In-Reply-To: <40cdc28f-ad90-a7b8-9a66-89439111703a@hale.ee>

On Mon, Sep 18, 2017 at 02:52:04PM +0700, Tom Hale wrote:
> Hi,
> 
> MAN PAGE
> 
> In http://man7.org/linux/man-pages/man8/pvscan.8.html I see the
> following issues:
> 
> * The string "-a--activate" appears several times. Should be:
>   "-a|--activate"

Yes, that's odd, the | exists in the source, but isn't being printed.
I'll just change to --activate for now.

> * "-a|--activate y|n|ay" is mentioned, but later on:
> "Only ay is applicable." Please remove "y|n|".

Unfortunately --activate is one of those options that was given different
acceptable values depending on the command, and we haven't added a special
case to the code that generates man pages to display it differently.

> PROGRAM
> 
> # pvscan --activate ay
>   Command does not accept option: --activate ay.
> 
> The message is confusing. It would be better to say "--activate requires
> --cache"

Yes, this is a limitation in the new code that matches what you have typed
to a specific command.  All possible commands are now defined here:
https://sourceware.org/git/?p=lvm2.git;a=blob_plain;f=tools/command-lines.in;hb=HEAD

It matches 'pvscan --activate' to the 'pvscan' command (which doesn't
accept -a, thus the error), rather than to the 'pvscan --cache' command
(which does accept -a).

      parent reply	other threads:[~2017-09-18 15:56 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-09-18  7:52 [linux-lvm] pvscan: bugs in manpage and implementation Tom Hale
2017-09-18 11:49 ` Zdenek Kabelac
2017-09-18 15:56 ` David Teigland [this message]

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=20170918155613.GA6025@redhat.com \
    --to=teigland@redhat.com \
    --cc=linux-lvm@redhat.com \
    --cc=tom@hale.ee \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).