Patchwork [2,of,5,V3] progress: move config help into core config help

login
register
mail settings
Submitter Pierre-Yves David
Date June 11, 2015, 7:31 a.m.
Message ID <c77874c1fb02168db13c.1434007894@marginatus.alto.octopoid.net>
Download mbox | patch
Permalink /patch/9600/
State Accepted
Headers show

Comments

Pierre-Yves David - June 11, 2015, 7:31 a.m.
# HG changeset patch
# User Pierre-Yves David <pierre-yves.david@fb.com>
# Date 1433962615 25200
#      Wed Jun 10 11:56:55 2015 -0700
# Node ID c77874c1fb02168db13c06fa9bcd12eaa8828142
# Parent  ce4b4a28464a4bd38ff360c88d44d720f79ebfe5
progress: move config help into core config help

This is core feature now.

Patch

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,51 @@  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.
+
+``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``
 ---------------
 
 Alias definitions for revsets. See :hg:`help revsets` for details.