perf: document the perfmanifest command
authorBoris Feld <boris.feld@octobus.net>
Wed, 11 Jul 2018 10:46:15 +0200
changeset 38693 9b6a708f2263
parent 38692 3700564c63fe
child 38694 55101513ed94
perf: document the perfmanifest command
contrib/perf.py
tests/test-contrib-perf.t
--- a/contrib/perf.py	Sat Jun 09 22:38:29 2018 +0900
+++ b/contrib/perf.py	Wed Jul 11 10:46:15 2018 +0200
@@ -774,6 +774,10 @@
 
 @command('perfmanifest', [], 'REV')
 def perfmanifest(ui, repo, rev, **opts):
+    """benchmark the time to read a manifest from disk and return a usable
+    dict-like object
+
+    Manifest caches are cleared before retrieval."""
     timer, fm = gettimer(ui, opts)
     ctx = scmutil.revsingle(repo, rev, rev)
     t = ctx.manifestnode()
--- a/tests/test-contrib-perf.t	Sat Jun 09 22:38:29 2018 +0900
+++ b/tests/test-contrib-perf.t	Wed Jul 11 10:46:15 2018 +0200
@@ -88,7 +88,8 @@
    perflookup    (no help text available)
    perflrucachedict
                  (no help text available)
-   perfmanifest  (no help text available)
+   perfmanifest  benchmark the time to read a manifest from disk and return a
+                 usable
    perfmergecalculate
                  (no help text available)
    perfmoonwalk  benchmark walking the changelog backwards