Mercurial > hg
comparison contrib/perf.py @ 42015:dbca2e5563c3
perf: document config options
We have configuration, so we better document it.
| author | Pierre-Yves David <pierre-yves.david@octobus.net> |
|---|---|
| date | Mon, 25 Mar 2019 13:43:40 +0100 |
| parents | 6a447a3d1bd0 |
| children | b900b392c1cc |
comparison
equal
deleted
inserted
replaced
| 42014:d93436e2ca6b | 42015:dbca2e5563c3 |
|---|---|
| 1 # perf.py - performance test routines | 1 # perf.py - performance test routines |
| 2 '''helper extension to measure performance''' | 2 '''helper extension to measure performance |
| 3 | |
| 4 Configurations | |
| 5 ============== | |
| 6 | |
| 7 ``perf`` | |
| 8 -------- | |
| 9 | |
| 10 ``all-timing`` | |
| 11 When set, additional statistic will be reported for each benchmark: best, | |
| 12 worst, median average. If not set only the best timing is reported | |
| 13 (default: off). | |
| 14 | |
| 15 ``presleep`` | |
| 16 number of second to wait before any group of run (default: 1) | |
| 17 | |
| 18 ``stub`` | |
| 19 When set, benchmark will only be run once, useful for testing (default: off) | |
| 20 ''' | |
| 3 | 21 |
| 4 # "historical portability" policy of perf.py: | 22 # "historical portability" policy of perf.py: |
| 5 # | 23 # |
| 6 # We have to do: | 24 # We have to do: |
| 7 # - make perf.py "loadable" with as wide Mercurial version as possible | 25 # - make perf.py "loadable" with as wide Mercurial version as possible |