# HG changeset patch
# User Pierre-Yves David <pierre-yves.david@octobus.net>
# Date 2019-03-25 12:43:40
# Node ID dbca2e5563c39acd130afd64ac47ddb8e77c38aa
# Parent  d93436e2ca6bd5faeda85ae9c052fdf69a137016

perf: document config options

We have configuration, so we better document it.

diff --git a/contrib/perf.py b/contrib/perf.py
--- a/contrib/perf.py
+++ b/contrib/perf.py
@@ -1,5 +1,23 @@
 # perf.py - performance test routines
-'''helper extension to measure performance'''
+'''helper extension to measure performance
+
+Configurations
+==============
+
+``perf``
+--------
+
+``all-timing``
+    When set, additional statistic will be reported for each benchmark: best,
+    worst, median average. If not set only the best timing is reported
+    (default: off).
+
+``presleep``
+  number of second to wait before any group of run (default: 1)
+
+``stub``
+    When set, benchmark will only be run once, useful for testing (default: off)
+'''
 
 # "historical portability" policy of perf.py:
 #
diff --git a/tests/test-contrib-perf.t b/tests/test-contrib-perf.t
--- a/tests/test-contrib-perf.t
+++ b/tests/test-contrib-perf.t
@@ -41,6 +41,24 @@ perfstatus
   $ hg help -e perf
   perf extension - helper extension to measure performance
   
+  Configurations
+  ==============
+  
+  "perf"
+  ------
+  
+  "all-timing"
+      When set, additional statistic will be reported for each benchmark: best,
+      worst, median average. If not set only the best timing is reported
+      (default: off).
+  
+  "presleep"
+    number of second to wait before any group of run (default: 1)
+  
+  "stub"
+      When set, benchmark will only be run once, useful for testing (default:
+      off)
+  
   list of commands:
   
    perfaddremove