Util-Linux package development
 help / color / mirror / Atom feed
From: Ruediger Meier <sweet_f_a@gmx.de>
To: Karel Zak <kzak@redhat.com>
Cc: Bernhard Voelker <mail@bernhard-voelker.de>, util-linux@vger.kernel.org
Subject: Re: [PATCH 3/3] tests: always quote $LODEV
Date: Mon, 7 Nov 2016 13:48:23 +0100	[thread overview]
Message-ID: <201611071348.23789.sweet_f_a@gmx.de> (raw)
In-Reply-To: <20161107113721.z53bvekbw3swgaxc@ws.net.home>

On Monday 07 November 2016, Karel Zak wrote:
> On Mon, Nov 07, 2016 at 11:21:55AM +0100, Ruediger Meier wrote:

> > BTW would be also very nice to ensure by design that --help,
> > manpage and the actual commands are always synchron.
>
> It depends what do you mean with synchron. All options should be
> documented by --help and man page, [...]

Yes it should, but we have very often inconsistencies, like

89de71b3
3fabc363
21c6bcbd
ce969b16

Bugs like these are IMO waste of human life time. They can be avoided 
automatically from the beginning.

> For --help we want really minimalistic and easy to 
> translate description. The man page is unlimited area for creative
> writers :-)

It's not a big problem to add manually written text to the autogenerated 
one. Even help2man has such interface (--include and --opt-include).

> Frankly, all we need is to detect mistakes (undocumented options).

Why would you want to detect this but not want to use existing tools?

> I'd like to be conservative and avoid complex solutions. I think our
> --help is nice and works as expected :-)

Even I've just run a stupid shell command line to find out that our 
getopt and flock have broken --help implementations. They print to 
stderr or do not return 0. I'm sure that we would find much more 
problems with the non-trivial options.

whereis has no such options --help/--version. Is this on purpose?

cu,
Rudi

  reply	other threads:[~2016-11-07 12:48 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-11-05 15:08 [PATCH 1/3] tests: udevadm settle before losetup -d Ruediger Meier
2016-11-05 15:08 ` [PATCH 2/3] tests: replace sleep by udevadm Ruediger Meier
2016-11-07 13:13   ` Stanislav Brabec
2016-11-05 15:08 ` [PATCH 3/3] tests: always quote $LODEV Ruediger Meier
2016-11-06 20:57   ` Bernhard Voelker
2016-11-07  8:58     ` Ruediger Meier
2016-11-07  9:41       ` Karel Zak
2016-11-07 10:21         ` Ruediger Meier
2016-11-07 11:37           ` Karel Zak
2016-11-07 12:48             ` Ruediger Meier [this message]
2016-11-07 13:38               ` Karel Zak
2016-11-07 13:52                 ` Karel Zak
2016-11-07  9:53 ` [PATCH 1/3] tests: udevadm settle before losetup -d Karel Zak

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=201611071348.23789.sweet_f_a@gmx.de \
    --to=sweet_f_a@gmx.de \
    --cc=kzak@redhat.com \
    --cc=mail@bernhard-voelker.de \
    --cc=util-linux@vger.kernel.org \
    /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