Patchwork [1,of,3] revsetbenchmarks: add main documention for the script

login
register
mail settings
Submitter Pierre-Yves David
Date June 17, 2015, 6:25 p.m.
Message ID <8d9c687c069ae920ebc9.1434565559@marginatus.alto.octopoid.net>
Download mbox | patch
Permalink /patch/9694/
State Accepted
Headers show

Comments

Pierre-Yves David - June 17, 2015, 6:25 p.m.
# HG changeset patch
# User Pierre-Yves David <pierre-yves.david@fb.com>
# Date 1434511477 25200
#      Tue Jun 16 20:24:37 2015 -0700
# Node ID 8d9c687c069ae920ebc9c823de307e8780a09095
# Parent  695b93a79d171bbcc4ac47b1229918ce809a5d65
revsetbenchmarks: add main documention for the script

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

Patch

diff --git a/contrib/revsetbenchmarks.py b/contrib/revsetbenchmarks.py
--- a/contrib/revsetbenchmarks.py
+++ b/contrib/revsetbenchmarks.py
@@ -207,12 +207,18 @@  def applyvariants(revset, variant):
         return revset
     for var in variant.split('+'):
         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")
 parser.add_option("-R", "--repo",
                   help="run benchmark on REPO", metavar="REPO")