Commit Graph

22 Commits

Author SHA1 Message Date
Vedant Kumar 1c5f312c70 [docs] Coverage: Improve the wording a bit
llvm-svn: 305745
2017-06-19 21:26:04 +00:00
Vedant Kumar 82cd770914 [docs] Coverage: document issue with the BFD linker
llvm-svn: 305743
2017-06-19 21:22:05 +00:00
Vedant Kumar 6eed0d5bb5 [docs] coverage: Clarify which flags enable gcov-style profiling (NFC)
Point out that --coverage and -ftest-coverage, which is what most people
are used to, do not enable clang's frontend based coverage pass.

Suggested by Benn Bolay!

llvm-svn: 294626
2017-02-09 21:33:21 +00:00
Nico Weber b1706ca107 Clarify how to forward-declare __llvm_profile symbols.
llvm-svn: 293065
2017-01-25 16:01:32 +00:00
Vedant Kumar 74c3fd1798 [docs] Touch up the coverage docs some more
llvm-svn: 282169
2016-09-22 15:34:33 +00:00
Vedant Kumar 6fe6eae7f7 [docs] Extend the code coverage docs some more
Flesh out the section on interpreting coverage reports, mention the
coverage export feature, and add notes on how to build llvm with
coverage turned on.

llvm-svn: 281988
2016-09-20 17:11:18 +00:00
Vedant Kumar 9ed5802680 [docs] Touch up the code coverage doc
llvm-svn: 281881
2016-09-19 01:42:38 +00:00
Vedant Kumar ae00885108 [docs] Coverage: Reference the new -output-dir option
llvm-svn: 277081
2016-07-28 23:22:42 +00:00
Vedant Kumar 3f42b13c20 [docs] Mention some new options in llvm-cov
llvm-svn: 277080
2016-07-28 23:18:48 +00:00
Sylvestre Ledru c0a3d717c7 fix two typos in the doc
llvm-svn: 274447
2016-07-02 19:17:58 +00:00
George Burgess IV bc8cc5ac9c [Docs] More warning fixes to unbreak the docs buildbot.
A number of warnings still remain, but these were the last of the
"unlexable code"-related ones (AFAICT).

I changed a few examples in docs/UsersManual.rst to showcase
-Wextra-tokens because it's already documented (-Wmultichar isn't), and
the sphinx C lexer apparently can't handle char literals like 'ab'. It
seemed like a better overall approach than just marking the code blocks
as none or console.

llvm-svn: 273232
2016-06-21 02:19:43 +00:00
Vedant Kumar f3300c9f74 [docs] Coverage: Document the profile merge pool specifier
llvm-svn: 272604
2016-06-14 00:42:12 +00:00
Vedant Kumar 89262b6928 [docs] Coverage: Clarify return value of __llvm_profile_write_file
llvm-svn: 272215
2016-06-08 22:32:03 +00:00
Vedant Kumar 32a9bfa42a [docs] Coverage: Flesh out instructions for avoiding static initializeres
llvm-svn: 272214
2016-06-08 22:24:52 +00:00
Vedant Kumar b06294da84 [docs] Coverage: Explain how to avoid static initializers
llvm-svn: 272067
2016-06-07 22:25:29 +00:00
Vedant Kumar 62baa4c752 [docs] Clarify limitations section of SourceBasedCodeCoverage.rst
Mention that the code coverage tool becomes less precise whenever
unpredictable changes in control flow occur.

Thanks to Sean Silva for pointing this out!

llvm-svn: 271902
2016-06-06 15:44:40 +00:00
Vedant Kumar 553a0d62f2 [docs] Add a limitations section to SourceBasedCodeCoverage.rst
llvm-svn: 271544
2016-06-02 17:19:45 +00:00
Vedant Kumar 6c53d8f94c [docs] Fix misplaced comma
llvm-svn: 271472
2016-06-02 02:45:59 +00:00
Vedant Kumar 0819f36ddd [docs] Minor formatting changes and typo fixes
llvm-svn: 271471
2016-06-02 02:25:13 +00:00
Vedant Kumar 4c1112c3b7 [docs] Use cpp code-blocks where appropriate
llvm-svn: 271461
2016-06-02 01:15:59 +00:00
Vedant Kumar 01d91eeac5 [docs] Add missing newline to console section
llvm-svn: 271457
2016-06-02 01:01:48 +00:00
Vedant Kumar a530a3615e [docs] Document the source-based code coverage feature
Differential Revision: http://reviews.llvm.org/D20715

llvm-svn: 271454
2016-06-02 00:51:50 +00:00