changeset 32850:e33c9a47b0db

config: document profiling.show{min,max}
author Gregory Szorc <gregory.szorc@gmail.com>
date Thu, 15 Jun 2017 11:04:46 -0700
parents e9fc5550be46
children cb6436e051ca
files mercurial/help/config.txt tests/test-check-config.t
diffstat 2 files changed, 21 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/mercurial/help/config.txt	Thu Jun 15 10:58:36 2017 -0700
+++ b/mercurial/help/config.txt	Thu Jun 15 11:04:46 2017 -0700
@@ -1573,6 +1573,27 @@
     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``
 ------------
 
--- a/tests/test-check-config.t	Thu Jun 15 10:58:36 2017 -0700
+++ b/tests/test-check-config.t	Thu Jun 15 11:04:46 2017 -0700
@@ -33,5 +33,3 @@
 
   $ 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]