]> granicus.if.org Git - python/commitdiff
Update help text and documentaition.
authorSteve Holden <steve@holdenweb.com>
Fri, 26 May 2006 22:33:20 +0000 (22:33 +0000)
committerSteve Holden <steve@holdenweb.com>
Fri, 26 May 2006 22:33:20 +0000 (22:33 +0000)
Tools/pybench/README
Tools/pybench/pybench.py

index 634e41b142e6d3a93671411ec271f0b123a4e4da..7d7eb8c3fe6d44f25a9fff96953591221ac9caa4 100644 (file)
@@ -46,6 +46,9 @@ Options and default settings:
   -w arg           set warp factor to arg (20)
   -d               hide noise in compares (0)
   --no-gc          disable garbage collection (0)
+  --no-syscheck    "disable" sys check interval (set to sys.maxint) (0)
+  -t arg           tests containing substring ()
+  -C arg           number of calibration runs (20)
   -v               generate verbose output
   -h               show this help text
   --help           show this help text
@@ -366,6 +369,14 @@ symbols defined in that module for subclasses of pybench.Test and
 automatically add them to the benchmark suite.
 
 
+Breaking Comparability
+----------------------
+
+If a change is made to any individual test that means it is no
+longer strcitly comparable with previous runs, the '.version' class
+variable should be updated. Therefafter, comparisons with previous
+versions of the test will list as "n/a" to reflect the change.
+
 Have fun,
 --
 Marc-Andre Lemburg
index 6167d1223f95fa541b2f8269f451c5ef9ae977fe..e0110d09d0d18c1d7467ef8a47735b63f9fed04d 100755 (executable)
@@ -382,7 +382,7 @@ class PyBenchCmdline(Application):
                SwitchOption('--no-syscheck',
                     '"disable" sys check interval (set to sys.maxint)', 0),
                ArgumentOption('-t', 'tests containing substring', ''),
-               ArgumentOption('-C', 'number of calibration runs (default 20)', 20)
+               ArgumentOption('-C', 'number of calibration runs', 20)
                ]
 
     about = """\