[PATCH 2 of 4 V2] progress: move config help into core config help

[Gilles Moris]

Le 10/06/2015 21:02, Pierre-Yves David a écrit :
> # HG changeset patch
> # User Pierre-Yves David <pierre-yves.david at fb.com>
> # Date 1433962615 25200
> #      Wed Jun 10 11:56:55 2015 -0700
> # Node ID 00e625c98575d0e6c93b57faaf741093285fd4b5
> # Parent  f81552058c8b90a5caca16aebe7fc2cb6de2d837
> progress: move config help into core config help
>
> This is core feature now.
>
> diff --git a/hgext/progress.py b/hgext/progress.py
> --- a/hgext/progress.py
> +++ b/hgext/progress.py
> @@ -9,32 +9,10 @@
>   
>   This extension uses the progress information logged by hg commands
>   to draw progress bars that are as informative as possible. Some progress
>   bars only offer indeterminate information, while others have a definite
>   end point.
> -
> -The following settings are available::
> -
> -  [progress]
> -  delay = 3 # number of seconds (float) before showing the progress bar
> -  changedelay = 1 # changedelay: minimum delay before showing a new topic.
> -                  # If set to less than 3 * refresh, that value will
> -                  # be used instead.
> -  refresh = 0.1 # time in seconds between refreshes of the progress bar
> -  format = topic bar number estimate # format of the progress bar
> -  width = <none> # if set, the maximum width of the progress information
> -                 # (that is, min(width, term width) will be used)
> -  clear-complete = True # clear the progress bar after it's done
> -  disable = False # if true, don't show a progress bar
> -  assume-tty = False # if true, ALWAYS show a progress bar, unless
> -                     # disable is given
> -
> -Valid entries for the format field are topic, bar, number, unit,
> -estimate, speed, and item. item defaults to the last 20 characters of
> -the item, but this can be changed by adding either ``-<num>`` which
> -would take the last num characters, or ``+<num>`` for the first num
> -characters.
>   """
>   
>   def uisetup(ui):
>       if ui.config('progress', 'disable', None) is None:
>           ui.setconfig('progress', 'disable', 'False', 'hgext-progress')
> diff --git a/mercurial/help/config.txt b/mercurial/help/config.txt
> --- a/mercurial/help/config.txt
> +++ b/mercurial/help/config.txt
> @@ -1212,10 +1212,48 @@ profiling is done using lsprof.
>       Show at most this number of lines of drill-down info after each main entry.
>       This can help explain the difference between Total and Inline.
>       Specific to the ``ls`` instrumenting profiler.
>       Default: 5.
>   
> +``progress``
> +------------
> +
> +Mercurial hg commands can draw progress bars that are as informative as
> +possible. Some progress bars only offer indeterminate information, while others
> +have a definite end point.

We lost the default values for all those config knob.
I think we should keep them.
> +
> +``delay``
> +    Number of seconds (float) before showing the progress bar.
> +
> +``changedelay``
> +    Minimum delay before showing a new topic. When set to less than 3 * refresh,
> +    that value will be used instead.
> +
> +``refresh``
> +    Time in seconds between refreshes of the progress bar.
> +
> +``format``
> +    Topic bar number estimate # format of the progress bar.
Do you want to keep the "# format of the progress bar"? Seems a comment 
of the previous example.
Or may be in parenthesis, or introduced by a word rather than "#".
> +
> +    Valid entries for the format field are topic, bar, number, unit, estimate,
> +    speed, and item. item defaults to the last 20 characters of the item, but
May be "topic", "bar", "number", ... should be quoted to make it clear 
they are expected keywords.
Or use some markup.

Regards.
Gilles.
> +    this can be changed by adding either ``-<num>`` which would take the last
> +    num characters, or ``+<num>`` for the first num characters.
> +
> +``width``
> +    If set, the maximum width of the progress information (that is, min(width,
> +    term width) will be used)
> +
> +``clear-complete``
> +    clear the progress bar after it's done (default to True)
> +
> +``disable``
> +    If true, don't show a progress bar
> +
> +``assume-tty``
> +    If true, ALWAYS show a progress bar, unless disable is given
> +
>   ``revsetalias``
>   ---------------
>   
>   Alias definitions for revsets. See :hg:`help revsets` for details.
>   
> _______________________________________________
> Mercurial-devel mailing list
> Mercurial-devel at selenic.com
> https://selenic.com/mailman/listinfo/mercurial-devel