perf: document `perfdirstate`
authorPierre-Yves David <pierre-yves.david@octobus.net>
Tue, 08 Oct 2019 01:46:57 -0400
changeset 43121 ce315b1fc9a7
parent 43120 97f80dd21312
child 43122 436a6a31df38
perf: document `perfdirstate`
contrib/perf.py
tests/test-contrib-perf.t
--- a/contrib/perf.py	Tue Oct 08 01:15:28 2019 -0400
+++ b/contrib/perf.py	Tue Oct 08 01:46:57 2019 -0400
@@ -1103,6 +1103,11 @@
 
 @command(b'perfdirstate', formatteropts)
 def perfdirstate(ui, repo, **opts):
+    """benchmap the time necessary to load a dirstate from scratch
+
+    The dirstate is loaded to the point were a "contains" request can be
+    answered.
+    """
     opts = _byteskwargs(opts)
     timer, fm = gettimer(ui, opts)
     b"a" in repo.dirstate
--- a/tests/test-contrib-perf.t	Tue Oct 08 01:15:28 2019 -0400
+++ b/tests/test-contrib-perf.t	Tue Oct 08 01:46:57 2019 -0400
@@ -107,7 +107,7 @@
    perfdirfoldmap
                  (no help text available)
    perfdirs      (no help text available)
-   perfdirstate  (no help text available)
+   perfdirstate  benchmap the time necessary to load a dirstate from scratch
    perfdirstatedirs
                  (no help text available)
    perfdirstatefoldmap