[llvm] r369054 - [Utils][NFC] Copy bisect usage documents from commit msg into script.

[Jinsong Ji via llvm-commits]

Author: jsji
Date: Thu Aug 15 15:07:59 2019
New Revision: 369054

URL: http://llvm.org/viewvc/llvm-project?rev=369054&view=rev
Log:
[Utils][NFC] Copy bisect usage documents from commit msg into script.

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.

Modified:
    llvm/trunk/utils/bisect

Modified: llvm/trunk/utils/bisect
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/utils/bisect?rev=369054&r1=369053&r2=369054&view=diff
==============================================================================
--- llvm/trunk/utils/bisect (original)
+++ llvm/trunk/utils/bisect Thu Aug 15 15:07:59 2019
@@ -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