perf: document `perfdirfoldmap`
authorPierre-Yves David <pierre-yves.david@octobus.net>
Tue, 08 Oct 2019 01:49:18 -0400
changeset 43127 0b32206c3c86
parent 43126 e337d8247375
child 43128 ad801d4af7cd
perf: document `perfdirfoldmap`
contrib/perf.py
tests/test-contrib-perf.t
--- a/contrib/perf.py	Tue Oct 08 02:16:15 2019 -0400
+++ b/contrib/perf.py	Tue Oct 08 01:49:18 2019 -0400
@@ -1163,6 +1163,10 @@
 
 @command(b'perfdirfoldmap', formatteropts)
 def perfdirfoldmap(ui, repo, **opts):
+    """benchmap a `dirstate._map.dirfoldmap.get()` request
+
+    The dirstate dirfoldmap cache is dropped between every request.
+    """
     opts = _byteskwargs(opts)
     timer, fm = gettimer(ui, opts)
     dirstate = repo.dirstate
--- a/tests/test-contrib-perf.t	Tue Oct 08 02:16:15 2019 -0400
+++ b/tests/test-contrib-perf.t	Tue Oct 08 01:49:18 2019 -0400
@@ -105,7 +105,7 @@
    perfctxfiles  (no help text available)
    perfdiffwd    Profile diff of working directory changes
    perfdirfoldmap
-                 (no help text available)
+                 benchmap a 'dirstate._map.dirfoldmap.get()' request
    perfdirs      (no help text available)
    perfdirstate  benchmap the time necessary to load a dirstate from scratch
    perfdirstatedirs