summaryrefslogtreecommitdiffstats
path: root/llvm/docs/ProgrammersManual.rst
diff options
context:
space:
mode:
authorJustin Bogner <mail@justinbogner.com>2015-02-21 20:53:36 +0000
committerJustin Bogner <mail@justinbogner.com>2015-02-21 20:53:36 +0000
commit08f36fd61d716b47d55003fe1f8741f249af41f1 (patch)
treec509ec1380e4771eac47412b25cfff7f4b470c0b /llvm/docs/ProgrammersManual.rst
parente738061c4900016238adf741e37dae099afe7c65 (diff)
downloadbcm5719-llvm-08f36fd61d716b47d55003fe1f8741f249af41f1.tar.gz
bcm5719-llvm-08f36fd61d716b47d55003fe1f8741f249af41f1.zip
docs: Mention that assertions must be enabled to use the -stats flag
Patch by Rob Stewart. Thanks! llvm-svn: 230144
Diffstat (limited to 'llvm/docs/ProgrammersManual.rst')
-rw-r--r--llvm/docs/ProgrammersManual.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/llvm/docs/ProgrammersManual.rst b/llvm/docs/ProgrammersManual.rst
index f140cf509d2..753e658b5b3 100644
--- a/llvm/docs/ProgrammersManual.rst
+++ b/llvm/docs/ProgrammersManual.rst
@@ -488,6 +488,9 @@ gathered, use the '``-stats``' option:
$ opt -stats -mypassname < program.bc > /dev/null
... statistics output ...
+Note that in order to use the '``-stats``' option, LLVM must be
+compiled with assertions enabled.
+
When running ``opt`` on a C file from the SPEC benchmark suite, it gives a
report that looks like this:
OpenPOWER on IntegriCloud