# HG changeset patch
# User Pierre-Yves David <pierre-yves.david@fb.com>
# Date 2015-06-17 03:24:37
# Node ID ddb2a648fdbd89141c4088009e8ae53409d890f5
# Parent  3bb6f5f478a70084782ad6ca9a31624a8ff3dd72

revsetbenchmarks: add main documention for the script

This allow us to document the fact we can use comment in the file listing revsets.

diff --git a/contrib/revsetbenchmarks.py b/contrib/revsetbenchmarks.py
--- a/contrib/revsetbenchmarks.py
+++ b/contrib/revsetbenchmarks.py
@@ -209,8 +209,14 @@ def applyvariants(revset, variant):
         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")