[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Gnu-arch-users] tla help text
From: |
David Allouche |
Subject: |
Re: [Gnu-arch-users] tla help text |
Date: |
Tue, 21 Sep 2004 14:04:39 +0200 |
On Tue, 2004-09-21 at 12:36 +1000, Zenaan Harkness wrote:
> Example:
>
> $ tla register-archive -H
> change an archive location registration
> usage: tla register-archive [options] [archive] location
>
> -h, --help Display a help message and exit.
> -H Display a verbose help message and exit.
> -V, --version Display a release identifier string
> and exit.
> -f, --force overwrite existing location
> -d, --delete delete archive registration
>
> Record the location of ARCHIVE.
> ...
>
>
> In the above, it would be clearer if [archive] were changed to [ARCHIVE]
> or perhaps ARCHIVE were changed to [archive]. I do a sort of variable
> substitution in my head, and the fact that the "variables" are not the
> same is repeatedly causing me to do a double take, and cross check
> carefully to see if I missed something.
In tla help messages, the convention seems to be to use UPPERCASE for
arguments (e.g. usage: tla star-merge [options] [FROM]).
Please branch tla, fix the help messages, and submit a merge request to
bug goo. Consider that as a retribution for the support you get from the
community.
--
-- ddaa