Mercurial > hg
changeset 25520:c8fada8d9db9
progress: move config help into core config help
This is core feature now.
| author | Pierre-Yves David <pierre-yves.david@fb.com> |
|---|---|
| date | Wed, 10 Jun 2015 11:56:55 -0700 |
| parents | 09e2cb2a00d7 |
| children | f5c906878a47 |
| files | hgext/progress.py mercurial/help/config.txt |
| diffstat | 2 files changed, 41 insertions(+), 22 deletions(-) [+] |
line wrap: on
line diff
--- a/hgext/progress.py Sun Jun 07 17:51:27 2015 -0700 +++ b/hgext/progress.py Wed Jun 10 11:56:55 2015 -0700 @@ -11,28 +11,6 @@ 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):
--- a/mercurial/help/config.txt Sun Jun 07 17:51:27 2015 -0700 +++ b/mercurial/help/config.txt Wed Jun 10 11:56:55 2015 -0700 @@ -1214,6 +1214,47 @@ Specific to the ``ls`` instrumenting profiler. Default: 5. +``progress`` +------------ + +Mercurial 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. + +``delay`` + Number of seconds (float) before showing the progress bar. (default: 3) + +``changedelay`` + Minimum delay before showing a new topic. When set to less than 3 * refresh, + that value will be used instead. (default: 1) + +``refresh`` + Time in seconds between refreshes of the progress bar. (default: 0.1) + +``format`` + Format of the progress bar. + + 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. + + (default: Topic bar number estimate) + +``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`` ---------------