revsetbenchmarks: add main documention for the script
authorPierre-Yves David <pierre-yves.david@fb.com>
Tue, 16 Jun 2015 20:24:37 -0700
changeset 25607 ddb2a648fdbd
parent 25606 3bb6f5f478a7
child 25608 2fea23d035d8
revsetbenchmarks: add main documention for the script This allow us to document the fact we can use comment in the file listing revsets.
contrib/revsetbenchmarks.py
--- a/contrib/revsetbenchmarks.py	Tue Jun 16 16:07:39 2015 +0800
+++ b/contrib/revsetbenchmarks.py	Tue Jun 16 20:24:37 2015 -0700
@@ -209,8 +209,14 @@
         revset = '%s(%s)' % (var, revset)
     return revset
 
-
-parser = OptionParser(usage="usage: %prog [options] <revs>")
+helptext="""This script will run multiple variants of provided revsets using
+different revisions in your mercurial repository. After the benchmark are run
+summary output is provided. Use itto demonstrate speed improvements or pin
+point regressions. Revsets to run are specified in a file (or from stdin), one
+revsets per line. Line starting with '#' will be ignored, allowing insertion of
+comments."""
+parser = OptionParser(usage="usage: %prog [options] <revs>",
+                      description=helptext)
 parser.add_option("-f", "--file",
                   help="read revset from FILE (stdin if omitted)",
                   metavar="FILE")