[PATCH] bzrlib/builtins.py - status command help improvement

[Jan Hudec]

On Mon, Sep 12, 2005 at 14:23:08 +0300, Jari Aalto wrote:
> 
> Regarding Martin's laste message how to improve the help, here is 
> proposed change.
> 
> *** modified file 'bzrlib/builtins.py'
> --- bzrlib/builtins.py 
> +++ bzrlib/builtins.py 
> @@ -30,8 +30,11 @@
>  class cmd_status(Command):
>      """Display status summary.
>  
> -    This reports on versioned and unknown files, reporting them
> -    grouped by state.  Possible states are:
> +    Report versioned and unknown files, reporting them grouped by
> +    state. NOTE: already added and commited files are not listed
> +    (see command 'bzr inventory').
> +
> +    Possible states are:

To me it sounds pretty weird.  Added *and commited* files are no longer
"added"---they are "versioned".  That's how *all* version control system I
know use the term "added".  I'd suggest:

NOTE: Files, that don't differ from the commited state are not listed
unless '--all' option is given (see also 'bzr inventory').

Because that's really what is going on here.

By the way, looking at the --all option I more and more think that the
inventory command should be merged into status (as the _only_ remaining
thing status does not show is ignored files).

>      added
>          Versioned in the working copy but not in the previous revision.
> @@ -59,8 +62,8 @@
>      changes to file texts, use 'bzr diff'.
>  
>      If no arguments are specified, the status of the entire working
> -    directory is shown.  Otherwise, only the status of the specified
> -    files or directories is reported.  If a directory is given, status
> +    directory is shown. Otherwise, only the status of the specified
> +    files or directories is reported. If a directory is given, status
>      is reported for everything inside that directory.
>      """

It is customary to put two spaces after a period in english text,
because in english typesetting the space after perod is longer than
normal. Please remain consistent with the rest of the help.

--
						 Jan 'Bulb' Hudec <bulb at ucw.cz>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: Digital signature
Url : https://lists.ubuntu.com/archives/bazaar/attachments/20050912/48acf673/attachment.pgp