contrib/perf.py
changeset 41437 d65ba1ff4559
parent 41436 ab6d1f82be32
child 41438 e9891c734bf8
--- a/contrib/perf.py	Fri Jan 25 14:53:19 2019 -0500
+++ b/contrib/perf.py	Mon Jan 28 04:47:40 2019 -0500
@@ -1017,6 +1017,14 @@
             (b'', b'rev', b'', b'revision to be looked up (default tip)'),
          ] + formatteropts)
 def perfindex(ui, repo, **opts):
+    """benchmark index creation time followed by a lookup
+
+    The default is to look `tip` up. Depending on the index implementation,
+    the revision looked up can matters. For example, an implementation
+    scanning the index will have a faster lookup time for `--rev tip` than for
+    `--rev 0`.
+
+    It is not currently possible to check for lookup of a missing node."""
     import mercurial.revlog
     opts = _byteskwargs(opts)
     timer, fm = gettimer(ui, opts)