summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--llvm/docs/CommandGuide/bugpoint.rst7
1 files changed, 6 insertions, 1 deletions
diff --git a/llvm/docs/CommandGuide/bugpoint.rst b/llvm/docs/CommandGuide/bugpoint.rst
index f11585d359c..6b56f04c835 100644
--- a/llvm/docs/CommandGuide/bugpoint.rst
+++ b/llvm/docs/CommandGuide/bugpoint.rst
@@ -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:
OpenPOWER on IntegriCloud