docs: Mention that assertions must be enabled to use the -stats flag

Patch by Rob Stewart. Thanks!

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@230144 91177308-0d34-0410-b5e6-96231b3b80d8

diff --git a/docs/ProgrammersManual.rst b/docs/ProgrammersManual.rst
index f140cf509d2520289077b9569444dfe456129e96..753e658b5b3d89d8406dcaca141b42fefb0ab739 100644 (file)
--- a/docs/ProgrammersManual.rst
+++ b/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: