[llvm] r264119 - [docs] Clarify the sense of --compile-command

[Sean Silva via llvm-commits]

Author: silvas
Date: Tue Mar 22 19:25:13 2016
New Revision: 264119

URL: http://llvm.org/viewvc/llvm-project?rev=264119&view=rev
Log:
[docs] Clarify the sense of --compile-command

In retrospect, it seems "obvious" that the sense of the return code is
the same as if it crashed on "interesting" inputs. But that didn't stop
me from spending more time than I care to admit verifying this.

Modified:
    llvm/trunk/docs/CommandGuide/bugpoint.rst

Modified: llvm/trunk/docs/CommandGuide/bugpoint.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/bugpoint.rst?rev=264119&r1=264118&r2=264119&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/bugpoint.rst (original)
+++ llvm/trunk/docs/CommandGuide/bugpoint.rst Tue Mar 22 19:25:13 2016
@@ -151,7 +151,12 @@ OPTIONS
 **--compile-command** *command*
 
  This option defines the command to use with the **--compile-custom**
- option to compile the bitcode testcase. This can be useful for
+ option to compile the bitcode testcase. The command should exit with a
+ failure exit code if the file is "interesting" and should exit with a
+ success exit code (i.e. 0) otherwise (this is the same as if it crashed on
+ "interesting" inputs).
+
+ This can be useful for
  testing compiler output without running any link or execute stages. To
  generate a reduced unit test, you may add CHECK directives to the
  testcase and pass the name of an executable compile-command script in this form: