comparison hgext/progress.py @ 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 0fa964d6fd48
children f5c906878a47
comparison
equal deleted inserted replaced
25519:09e2cb2a00d7 25520:c8fada8d9db9
9 9
10 This extension uses the progress information logged by hg commands 10 This extension uses the progress information logged by hg commands
11 to draw progress bars that are as informative as possible. Some progress 11 to draw progress bars that are as informative as possible. Some progress
12 bars only offer indeterminate information, while others have a definite 12 bars only offer indeterminate information, while others have a definite
13 end point. 13 end point.
14
15 The following settings are available::
16
17 [progress]
18 delay = 3 # number of seconds (float) before showing the progress bar
19 changedelay = 1 # changedelay: minimum delay before showing a new topic.
20 # If set to less than 3 * refresh, that value will
21 # be used instead.
22 refresh = 0.1 # time in seconds between refreshes of the progress bar
23 format = topic bar number estimate # format of the progress bar
24 width = <none> # if set, the maximum width of the progress information
25 # (that is, min(width, term width) will be used)
26 clear-complete = True # clear the progress bar after it's done
27 disable = False # if true, don't show a progress bar
28 assume-tty = False # if true, ALWAYS show a progress bar, unless
29 # disable is given
30
31 Valid entries for the format field are topic, bar, number, unit,
32 estimate, speed, and item. item defaults to the last 20 characters of
33 the item, but this can be changed by adding either ``-<num>`` which
34 would take the last num characters, or ``+<num>`` for the first num
35 characters.
36 """ 14 """
37 15
38 def uisetup(ui): 16 def uisetup(ui):
39 if ui.config('progress', 'disable', None) is None: 17 if ui.config('progress', 'disable', None) is None:
40 ui.setconfig('progress', 'disable', 'False', 'hgext-progress') 18 ui.setconfig('progress', 'disable', 'False', 'hgext-progress')