]> granicus.if.org Git - llvm/commitdiff
[Utils][NFC] Copy bisect usage documents from commit msg into script.
authorJinsong Ji <jji@us.ibm.com>
Thu, 15 Aug 2019 22:07:59 +0000 (22:07 +0000)
committerJinsong Ji <jji@us.ibm.com>
Thu, 15 Aug 2019 22:07:59 +0000 (22:07 +0000)
Copy the message into script, so that new users won't need to dig into
commit messages to figure out how to use.

The message are copied directly from Michael's commit message in
https://reviews.llvm.org/rL214610.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@369054 91177308-0d34-0410-b5e6-96231b3b80d8

utils/bisect

index d1b12575e9c321582228eda3a9fe3fbefcc62587..0f9e53afa7f4a195faccfe0e5f1bfc88fc44d22b 100755 (executable)
@@ -1,5 +1,17 @@
 #!/usr/bin/env python
-
+#
+# The way you use this is you create a script that takes in as its first
+# argument a count. The script passes into LLVM the count via a command
+# line flag that disables a pass after LLVM has run after the pass has
+# run for count number of times. Then the script invokes a test of some
+# sort and indicates whether LLVM successfully compiled the test via the
+# scripts exit status. Then you invoke bisect as follows:
+#
+# bisect --start=<start_num> --end=<end_num> ./script.sh "%(count)s"
+#
+# And bisect will continually call ./script.sh with various counts using
+# the exit status to determine success and failure.
+#
 import os
 import sys
 import argparse