[PATCH] D52314: Document bisect-skip-count

[David Greene via Phabricator via llvm-commits]

This revision was not accepted when it landed; it landed in state "Needs Review".
This revision was automatically updated to reflect the committed changes.
Closed by commit rL344903: Document bisect-skip-count (authored by greened, committed by ).

Changed prior to commit:
  https://reviews.llvm.org/D52314?vs=170406&id=170407#toc

Repository:
  rL LLVM

https://reviews.llvm.org/D52314

Files:
  llvm/trunk/utils/bisect-skip-count


Index: llvm/trunk/utils/bisect-skip-count
===================================================================
--- llvm/trunk/utils/bisect-skip-count
+++ llvm/trunk/utils/bisect-skip-count
@@ -1,6 +1,25 @@
 #!/usr/bin/env python
 # This script is used to bisect skip and count arguments for --debug-counter.
 # It is similar to bisect, except it understands how to increase skip and decrease count
+#
+# Typical usage:
+#
+# bisect-skip-count bisect-command.sh "%(skip)d" "%(count)d" 2>&1 | tee bisect.out
+#
+# bisect-command.sh is something like this:
+# #! /bin/bash
+#
+# skip=$1
+# count=$2
+#
+# opt -debug-counter=my-counter-skip=${skip},my-counter-count=${count}
+# ... Test output of opt and exit zero for pass, non-zero for fail
+#
+# Examine bisect.out to look for "Last good skip" and "Last good
+# count" to find the values of the counter that produce a passing
+# result.  Incrementing the last good count by one or decrementing the
+# last good skip by one should produce a failure.
+#
 import os
 import sys
 import argparse


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D52314.170407.patch
Type: text/x-patch
Size: 1040 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20181022/b8aa143e/attachment.bin>