[Freeipa-devel] [PATCH] 203 Add argument help to CLI

Rob Crittenden rcritten at redhat.com
Mon Jan 30 16:22:16 UTC 2012


Martin Kosek wrote:
> An example of the improved help:
>
> # ipa help user-add
> Purpose: Add a new user.
> Usage: ipa [global-options] user-add LOGIN [options]
>
> Positional arguments:
> LOGIN: User login
>
> Options:
>    -h, --help         show this help message and exit
>    --first=STR        First name
>    --last=STR         Last name
>    --cn=STR           Full name
> ...
>
>
> We may want to improve help for most arguments we use. Most of them are
> missing. In this patch I updated just the CRITERIA argument that was
> complained about in the relevant BZ.
>
> Martin

Patch looks ok, I just think the output could be improved.

I think it should look similar to the existing usage output, so, similar 
indention and description columns lined up:

Usage: ipa [global-options] user-add LOGIN [options]

Positional arguments:
   LOGIN              User login

Options:
   -h, --help         show this help message and exit

rob




More information about the Freeipa-devel mailing list