Mercurial > hg
changeset 25607:ddb2a648fdbd
revsetbenchmarks: add main documention for the script
This allow us to document the fact we can use comment in the file listing revsets.
| author | Pierre-Yves David <pierre-yves.david@fb.com> |
|---|---|
| date | Tue, 16 Jun 2015 20:24:37 -0700 |
| parents | 3bb6f5f478a7 |
| children | 2fea23d035d8 |
| files | contrib/revsetbenchmarks.py |
| diffstat | 1 files changed, 8 insertions(+), 2 deletions(-) [+] |
line wrap: on
line diff
--- 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")