Patchwork [5,of,6] config: document profiling.show{min,max}

login
register
mail settings
Submitter Gregory Szorc
Date June 15, 2017, 6:18 p.m.
Message ID <4c12e71de97e5e390e8e.1497550695@ubuntu-vm-main>
Download mbox | patch
Permalink /patch/21398/
State Accepted
Headers show

Comments

Gregory Szorc - June 15, 2017, 6:18 p.m.
# HG changeset patch
# User Gregory Szorc <gregory.szorc@gmail.com>
# Date 1497549886 25200
#      Thu Jun 15 11:04:46 2017 -0700
# Node ID 4c12e71de97e5e390e8ee78f9942724a5f024d64
# Parent  92d8ae773d851bcf4d6a2e27a97ee1f749aabb99
config: document profiling.show{min,max}

Patch

diff --git a/mercurial/help/config.txt b/mercurial/help/config.txt
--- a/mercurial/help/config.txt
+++ b/mercurial/help/config.txt
@@ -1573,6 +1573,27 @@  profiling is done using lsprof.
     Specific to the ``ls`` instrumenting profiler.
     (default: 5)
 
+``showmin``
+    Minimum fraction of samples an entry must have for it to be displayed.
+    Can be specified as a float between ``0.0`` and ``1.0`` or can have a
+    ``%`` afterwards to allow values up to ``100``. e.g. ``5%``.
+
+    Only used by the ``stat`` profiler.
+
+    For the ``chrome`` format, default is ``0.005``.
+
+    The option is unused on other formats.
+
+``showmax``
+    Maximum fraction of samples an entry can have before it is ignored in
+    display. Values format is the same as ``showmin``.
+
+    Only used by the ``stat`` profiler.
+
+    For the ``chrome`` format, default is ``0.999``.
+
+    The option is unused on other formats.
+
 ``progress``
 ------------
 
diff --git a/tests/test-check-config.t b/tests/test-check-config.t
--- a/tests/test-check-config.t
+++ b/tests/test-check-config.t
@@ -33,5 +33,3 @@  New errors are not allowed. Warnings are
 
   $ hg files "set:(**.py or **.txt) - tests/**" | sed 's|\\|/|g' |
   >   python contrib/check-config.py
-  undocumented: profiling.showmax (with) [0.999]
-  undocumented: profiling.showmin (with) [0.005]