[PATCH 01 of 13] perf: document `perfstatus`

[Pierre-Yves David]

# HG changeset patch
# User Pierre-Yves David <pierre-yves.david at octobus.net>
# Date 1570511728 14400
#      Tue Oct 08 01:15:28 2019 -0400
# Node ID 8d066f6d8a5716e88812487d7d1c7db2808bb9bb
# Parent  9002f4a3dde63518d1467f3934a1fe226f3b2297
# EXP-Topic perf-doc
# Available At https://bitbucket.org/octobus/mercurial-devel/
#              hg pull https://bitbucket.org/octobus/mercurial-devel/ -r 8d066f6d8a57
perf: document `perfstatus`

diff --git a/contrib/perf.py b/contrib/perf.py
--- a/contrib/perf.py
+++ b/contrib/perf.py
@@ -764,6 +764,13 @@ def perfannotate(ui, repo, f, **opts):
     + formatteropts,
 )
 def perfstatus(ui, repo, **opts):
+    """benchmark the performance of a single status call
+
+    The repository data are preserved between each call.
+
+    By default, only the status of the tracked file are requested. If
+    `--unknown` is passed, the "unknown" files are also tracked.
+    """
     opts = _byteskwargs(opts)
     # m = match.always(repo.root, repo.getcwd())
     # timer(lambda: sum(map(len, repo.dirstate.status(m, [], False, False,
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
@@ -172,7 +172,7 @@ perfstatus
    perfrevrange  (no help text available)
    perfrevset    benchmark the execution time of a revset
    perfstartup   (no help text available)
-   perfstatus    (no help text available)
+   perfstatus    benchmark the performance of a single status call
    perftags      (no help text available)
    perftemplating
                  test the rendering time of a given template