[PATCH] status: copy-edit and improve --terse and --verbose help

[Matt Harbison]

On Tue, 10 Oct 2017 11:29:56 -0400, Kevin Bullock  
<kbullock+mercurial at ringworld.org> wrote:

> # HG changeset patch
> # User Kevin Bullock <kbullock+mercurial at ringworld.org>
> # Date 1507649255 18000
> #      Tue Oct 10 10:27:35 2017 -0500
> # Node ID 6bd1153bd3981b712759b490efa49b9a8f5e4987
> # Parent  60213a2eca81af4e1daa3ef9e44af859ba1e5756
> status: copy-edit and improve --terse and --verbose help
>
> diff --git a/mercurial/commands.py b/mercurial/commands.py
> --- a/mercurial/commands.py
> +++ b/mercurial/commands.py
> @@ -4719,28 +4719,23 @@ def status(ui, repo, *pats, **opts):
>     .. container:: verbose
> -      The -t/--terse option abbreviates the output by showing directory  
> name
> -      if all the files in it share the same status. The option expects  
> a value
> -      which can be a string formed by using 'm', 'a', 'r', 'd', 'u',  
> 'i', 'c'
> -      where, 'm' stands for 'modified', 'a' for 'added', 'r' for  
> 'removed',
> -      'd' for 'deleted', 'u' for 'unknown', 'i' for 'ignored' and 'c'  
> for clean.
> -
> -      It terses the output of only those status which are passed. The  
> ignored
> -      files are not considered while tersing until 'i' is there in  
> --terse value
> -      or the --ignored option is used.
> -
> -      --verbose option shows more context about the state of the repo
> -      like the repository is in unfinised merge, shelve, rebase state  
> etc.
> -      You can have this behaviour turned on by default by following  
> config:
> -
> -      [commands]
> -      status.verbose = true
> -
> -      You can also skip some states like bisect by adding following in
> -      configuration file.
> -
> -      [commands]
> -      status.skipstates = bisect
> +      The -t/--terse option abbreviates the output by showing directory  
> name if

"... by showing _the_ directory name ..." ?

> +      all the files in it share the same status. The option takes an  
> argument
> +      indicating the statuses to abbreviate: 'm' for 'modified', 'a' for
> +      'added', 'r' for 'removed', 'd' for 'deleted', 'u' for 'unknown',  
> 'i' for
> +      'ignored' and 'c' for clean.
> +
> +      It abbreviates only those statuses which are passed. Note that  
> ignored
> +      files are not displayed with '--terse i' unless the -i/--ignored  
> option is
> +      also used.
> +
> +      The -v/--verbose option shows information whenq the repository is  
> in an

s/whenq/when/

> +      unfinished merge, shelve, rebase state etc. You can have this  
> behaviour

It was like this before, but it seems like the prevailing spelling is  
'behavior':

   $ grep -Ihr 'behavior' ../i18n | sort | uniq | wc -l
   51

   $ grep -Ihr 'behaviour' ../i18n | sort | uniq | wc -l
   3

> +      turned on by default by enabling the ``commands.status.verbose``  
> option.
> +
> +      You can skip displaying some of these states by setting
> +      ``commands.status.skipstates`` to one or more of: 'bisect',  
> 'graft',
> +      'histedit', 'merge', 'rebase', or 'unshelve'.
>       Examples:
> @@ -4762,7 +4757,13 @@ def status(ui, repo, *pats, **opts):
>           hg status -an0
> +      - show more information about the repository status, abbreviating
> +        untracked paths::
> +
> +          hg status -v -tu
> +
>      Returns 0 on success.
> +
>      """
>     opts = pycompat.byteskwargs(opts)
> _______________________________________________
> Mercurial-devel mailing list
> Mercurial-devel at mercurial-scm.org
> https://www.mercurial-scm.org/mailman/listinfo/mercurial-devel