From: Justin Bogner <mail@justinbogner.com>
Date: Sat, 21 Feb 2015 20:53:36 +0000 (+0000)
Subject: docs: Mention that assertions must be enabled to use the -stats flag
X-Git-Url: http://demsky.eecs.uci.edu/git/?a=commitdiff_plain;h=ad821f0482402647248271850e2e665c7fa39c70;p=oota-llvm.git

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 f140cf509d2..753e658b5b3 100644
--- 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: