# HG changeset patch
# User Pierre-Yves David <pierre-yves.david@octobus.net>
# Date 2019-03-25 15:41:02
# Node ID b900b392c1cc05bacbb41d0047b20abb8544c6e7
# Parent  dbca2e5563c39acd130afd64ac47ddb8e77c38aa

perf: document perfparents

diff --git a/contrib/perf.py b/contrib/perf.py
--- a/contrib/perf.py
+++ b/contrib/perf.py
@@ -1164,6 +1164,13 @@ def perfstartup(ui, repo, **opts):
 
 @command(b'perfparents', formatteropts)
 def perfparents(ui, repo, **opts):
+    """benchmark the time necessary to fetch one changeset's parents.
+
+    The fetch is done using the `node identifier`, traversing all object layer
+    from the repository object. The N first revision will be used for this
+    benchmark. N is controlled by the ``perf.parentscount`` config option
+    (default: 1000).
+    """
     opts = _byteskwargs(opts)
     timer, fm = gettimer(ui, opts)
     # control the number of commits perfparents iterates over
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
@@ -129,7 +129,7 @@ perfstatus
                  (no help text available)
    perfnodemap   benchmark the time necessary to look up revision from a cold
                  nodemap
-   perfparents   (no help text available)
+   perfparents   benchmark the time necessary to fetch one changeset's parents.
    perfpathcopies
                  benchmark the copy tracing logic
    perfphases    benchmark phasesets computation