Add more decsriptions for bisect-benchmark

Author: msimacek

bisect-benchmark.ini

@@ -3,12 +3,11 @@
 # Usage:
 # - Create a temporary branch based on master (or the bad commit)
 # - Fill in this configuration file, commit the changes and push it
-# TODO job name
-# - Execute the $name job for the commit. When you click the "create PR" link,
-#   you can run jobs in commits UI. You need to wait a bit for the job
-#   enumerator to populate the job list. You don't need to actually create the
-#   PR.
-# - Wat for the jobs to finish. TODO
+# - Execute the bisect-benchmark job for the commit. When you click the "create
+#   PR" link, you can run jobs in commits UI (Actions). You need to wait a bit
+#   for the job enumerator to populate the job list. You don't need to actually
+#   create any PR.
+# - Wait for the jobs to finish. You should get an email when it's done
 
 # The command to build particular configuration. You can copy paste this from
 # the benchmark job log. Don't worry about sforceimports, the script takes care
@@ -21,11 +20,16 @@ build_command = mx --dy /compiler build
 # benchmark at a time
 benchmark_command = mx --dy /compiler benchmark micro:try-except-simple
 
-# The first known "bad" merge commit for bisection
+# The first known "bad" merge commit for bisection. Try to use long commit
+# SHAs, the CI cache has higher probability of short SHAs being ambiguous
 bad = 1234deadbeef
 
 # The last known "good" merge commit for bisection
 good = 1234cafebabe
 
 # Whether to checkout graal-enterprise
 enterprise = true
+
+# Which result parameter should be used for comparisons, one of BEST, WORST,
+# AVG (all runs), AVG (no warmup)
+benchmark_criterion = BEST

mx.graalpython/mx_graalpython_bisect.py

@@ -150,13 +150,14 @@ def bisect_benchmark(argv):
         args.enterprise = sec.getboolean('enterprise', False)
     else:
         parser = argparse.ArgumentParser()
-        parser.add_mutually_exclusive_group()
-        parser.add_argument('bad')
-        parser.add_argument('good')
-        parser.add_argument('build_command')
-        parser.add_argument('benchmark_command')
-        parser.add_argument('--benchmark-criterion', default='BEST')
-        parser.add_argument('--enterprise', action='store_true')
+        parser.add_argument('bad', help="Bad commit for bisection")
+        parser.add_argument('good', help="Good commit for bisection")
+        parser.add_argument('build_command', help="Command to run in order to build the configuration")
+        parser.add_argument('benchmark_command',
+                            help="Command to run in order to run the benchmark. Output needs to be in mx's format")
+        parser.add_argument('--benchmark-criterion', default='BEST',
+                            help="Which result parameter should be used for comparisons")
+        parser.add_argument('--enterprise', action='store_true', help="Whether to checkout graal-enterprise")
         args = parser.parse_args(argv)
 
     primary_suite = mx.primary_suite()