[PATCH] Explain in docs that assertions must be enabled to use the -stats flag

[Justin Bogner]

Rob Stewart <robstewart57 at gmail.com> writes:
> On llvm-dev there was a recent question about -stats, namely that it did not print out statistics about passes with the -stats `opt` flag.
> http://lists.cs.uiuc.edu/pipermail/llvmdev/2015-February/082409.html
>
> The answer is that assertions must be enabled.
> http://lists.cs.uiuc.edu/pipermail/llvmdev/2015-February/082461.html
>
> This commit adds that information to the programmers manual document.

Nice. I've committed this for you in r230144.

> http://reviews.llvm.org/D7812
>
> Files:
>   docs/ProgrammersManual.rst
>
> Index: docs/ProgrammersManual.rst
> ===================================================================
> --- docs/ProgrammersManual.rst
> +++ docs/ProgrammersManual.rst
> @@ -488,6 +488,9 @@
>    $ 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:
>
> EMAIL PREFERENCES
>   http://reviews.llvm.org/settings/panel/emailpreferences/
>
> _______________________________________________
> llvm-commits mailing list
> llvm-commits at cs.uiuc.edu
> http://lists.cs.uiuc.edu/mailman/listinfo/llvm-commits