This is an archive of the discontinued Mercurial Phabricator instance.

Differential D6170

perf: copyedit a few documentation strings
ClosedPublic

Authored by durin42 on Mar 26 2019, 10:21 AM.

Details

Reviewers
pulkit
Group Reviewers
hg-reviewers
Commits
rHG4c700c847aa2: perf: copyedit a few documentation strings

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

durin42 created this revision.Mar 26 2019, 10:21 AM
pulkit accepted this revision.Mar 27 2019, 6:19 AM
pulkit added a comment.EditedMar 27 2019, 6:27 AM

Amending the following diff in flight.

diff --git a/contrib/perf.py b/contrib/perf.py
--- a/contrib/perf.py
+++ b/contrib/perf.py
@@ -26,7 +26,8 @@ Configurations
   The default value is: `3.0-100, 10.0-3`
 
 ``stub``
-    When set, benchmarks will only be run once, useful for testing (default: off)
+    When set, benchmarks 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
@@ -48,25 +48,25 @@ perfstatus
   ------
   
   "all-timing"
-      When set, additional statistic will be reported for each benchmark: best,
+      When set, additional statistics 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)
+    number of second to wait before any group of runs (default: 1)
   
   "run-limits"
-    Control the number of run each benchmark will perform. The option value
+    Control the number of runs each benchmark will perform. The option value
     should be a list of '<time>-<numberofrun>' pairs. After each run the
-    condition are considered in order with the following logic:
+    conditions are considered in order with the following logic:
   
-        If benchmark have been running for <time> seconds, and we have performed
+        If benchmark has been running for <time> seconds, and we have performed
         <numberofrun> iterations, stop the benchmark,
   
     The default value is: '3.0-100, 10.0-3'
   
   "stub"
-      When set, benchmark will only be run once, useful for testing (default:
+      When set, benchmarks will only be run once, useful for testing (default:
       off)
   
   list of commands:

( Looks like we found an issue with emacs thing for check-code )

Closed by commit rHG4c700c847aa2: perf: copyedit a few documentation strings (authored by durin42). · Explain WhyMar 27 2019, 9:32 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mcontrib/perf.py (19 lines)
Mtests/test-contrib-perf.t (12 lines)

Diff 14595

contrib/perf.py

# perf.py - performance test routines # perf.py - performance test routines
'''helper extension to measure performance '''helper extension to measure performance
Configurations Configurations
============== ==============
``perf`` ``perf``
-------- --------
``all-timing`` ``all-timing``
When set, additional statistic will be reported for each benchmark: best, When set, additional statistics will be reported for each benchmark: best,
worst, median average. If not set only the best timing is reported worst, median average. If not set only the best timing is reported
(default: off). (default: off).
``presleep`` ``presleep``
number of second to wait before any group of run (default: 1) number of second to wait before any group of runs (default: 1)
``run-limits`` ``run-limits``
Control the number of run each benchmark will perform. The option value Control the number of runs each benchmark will perform. The option value
should be a list of `<time>-<numberofrun>` pairs. After each run the should be a list of `<time>-<numberofrun>` pairs. After each run the
condition are considered in order with the following logic: conditions are considered in order with the following logic:
If benchmark have been running for <time> seconds, and we have performed If benchmark has been running for <time> seconds, and we have performed
<numberofrun> iterations, stop the benchmark, <numberofrun> iterations, stop the benchmark,
The default value is: `3.0-100, 10.0-3` The default value is: `3.0-100, 10.0-3`
``stub`` ``stub``
When set, benchmark will only be run once, useful for testing (default: off) When set, benchmarks will only be run once, useful for testing
(default: off)
''' '''
# "historical portability" policy of perf.py: # "historical portability" policy of perf.py:
# #
# We have to do: # We have to do:
# - make perf.py "loadable" with as wide Mercurial version as possible # - make perf.py "loadable" with as wide Mercurial version as possible
# This doesn't mean that perf commands work correctly with that Mercurial. # This doesn't mean that perf commands work correctly with that Mercurial.
# BTW, perf.py itself has been available since 1.1 (or eb240755386d). # BTW, perf.py itself has been available since 1.1 (or eb240755386d).
os.system(r"%s version -q > NUL" % sys.argv[0]) os.system(r"%s version -q > NUL" % sys.argv[0])
timer(d) timer(d)
fm.end() fm.end()
@command(b'perfparents', formatteropts) @command(b'perfparents', formatteropts)
def perfparents(ui, repo, **opts): def perfparents(ui, repo, **opts):
"""benchmark the time necessary to fetch one changeset's parents. """benchmark the time necessary to fetch one changeset's parents.
The fetch is done using the `node identifier`, traversing all object layer The fetch is done using the `node identifier`, traversing all object layers
from the repository object. The N first revision will be used for this from the repository object. The first N revisions will be used for this
benchmark. N is controlled by the ``perf.parentscount`` config option benchmark. N is controlled by the ``perf.parentscount`` config option
(default: 1000). (default: 1000).
""" """
opts = _byteskwargs(opts) opts = _byteskwargs(opts)
timer, fm = gettimer(ui, opts) timer, fm = gettimer(ui, opts)
# control the number of commits perfparents iterates over # control the number of commits perfparents iterates over
# experimental config: perf.parentscount # experimental config: perf.parentscount
count = getint(ui, b"perf", b"parentscount", 1000) count = getint(ui, b"perf", b"parentscount", 1000)

tests/test-contrib-perf.t

Configurations Configurations
============== ==============
"perf" "perf"
------ ------
"all-timing" "all-timing"
When set, additional statistic will be reported for each benchmark: best, When set, additional statistics will be reported for each benchmark: best,
worst, median average. If not set only the best timing is reported worst, median average. If not set only the best timing is reported
(default: off). (default: off).
"presleep" "presleep"
number of second to wait before any group of run (default: 1) number of second to wait before any group of runs (default: 1)
"run-limits" "run-limits"
Control the number of run each benchmark will perform. The option value Control the number of runs each benchmark will perform. The option value
should be a list of '<time>-<numberofrun>' pairs. After each run the should be a list of '<time>-<numberofrun>' pairs. After each run the
condition are considered in order with the following logic: conditions are considered in order with the following logic:
If benchmark have been running for <time> seconds, and we have performed If benchmark has been running for <time> seconds, and we have performed
<numberofrun> iterations, stop the benchmark, <numberofrun> iterations, stop the benchmark,
The default value is: '3.0-100, 10.0-3' The default value is: '3.0-100, 10.0-3'
"stub" "stub"
When set, benchmark will only be run once, useful for testing (default: When set, benchmarks will only be run once, useful for testing (default:
off) off)
list of commands: list of commands:
perfaddremove perfaddremove
(no help text available) (no help text available)
perfancestors perfancestors
(no help text available) (no help text available)