Commit Graph

22 Commits

Author SHA1 Message Date
Vedant Kumar de5743d657 [docs] Coverage: Improve the wording a bit
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@305745 91177308-0d34-0410-b5e6-96231b3b80d8
2017-06-19 21:26:04 +00:00
Vedant Kumar ff84b94035 [docs] Coverage: document issue with the BFD linker
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@305743 91177308-0d34-0410-b5e6-96231b3b80d8
2017-06-19 21:22:05 +00:00
Vedant Kumar bc505a9b46 [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!

git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@294626 91177308-0d34-0410-b5e6-96231b3b80d8
2017-02-09 21:33:21 +00:00
Nico Weber bf900fb167 Clarify how to forward-declare __llvm_profile symbols.
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@293065 91177308-0d34-0410-b5e6-96231b3b80d8
2017-01-25 16:01:32 +00:00
Vedant Kumar 2f1019880e [docs] Touch up the coverage docs some more
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@282169 91177308-0d34-0410-b5e6-96231b3b80d8
2016-09-22 15:34:33 +00:00
Vedant Kumar 95aa5d9d7a [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.

git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@281988 91177308-0d34-0410-b5e6-96231b3b80d8
2016-09-20 17:11:18 +00:00
Vedant Kumar c338f66d39 [docs] Touch up the code coverage doc
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@281881 91177308-0d34-0410-b5e6-96231b3b80d8
2016-09-19 01:42:38 +00:00
Vedant Kumar 24ebc2ed10 [docs] Coverage: Reference the new -output-dir option
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@277081 91177308-0d34-0410-b5e6-96231b3b80d8
2016-07-28 23:22:42 +00:00
Vedant Kumar c15796190b [docs] Mention some new options in llvm-cov
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@277080 91177308-0d34-0410-b5e6-96231b3b80d8
2016-07-28 23:18:48 +00:00
Sylvestre Ledru d65c23f6e4 fix two typos in the doc
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@274447 91177308-0d34-0410-b5e6-96231b3b80d8
2016-07-02 19:17:58 +00:00
George Burgess IV 7d29e48887 [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.


git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@273232 91177308-0d34-0410-b5e6-96231b3b80d8
2016-06-21 02:19:43 +00:00
Vedant Kumar ade89cd31c [docs] Coverage: Document the profile merge pool specifier
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@272604 91177308-0d34-0410-b5e6-96231b3b80d8
2016-06-14 00:42:12 +00:00
Vedant Kumar 8992cdfa97 [docs] Coverage: Clarify return value of __llvm_profile_write_file
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@272215 91177308-0d34-0410-b5e6-96231b3b80d8
2016-06-08 22:32:03 +00:00
Vedant Kumar fd13d079f2 [docs] Coverage: Flesh out instructions for avoiding static initializeres
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@272214 91177308-0d34-0410-b5e6-96231b3b80d8
2016-06-08 22:24:52 +00:00
Vedant Kumar 4acf6c38cb [docs] Coverage: Explain how to avoid static initializers
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@272067 91177308-0d34-0410-b5e6-96231b3b80d8
2016-06-07 22:25:29 +00:00
Vedant Kumar 23c6d52113 [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!

git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@271902 91177308-0d34-0410-b5e6-96231b3b80d8
2016-06-06 15:44:40 +00:00
Vedant Kumar c5614d4b4c [docs] Add a limitations section to SourceBasedCodeCoverage.rst
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@271544 91177308-0d34-0410-b5e6-96231b3b80d8
2016-06-02 17:19:45 +00:00
Vedant Kumar 2c5371a0c5 [docs] Fix misplaced comma
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@271472 91177308-0d34-0410-b5e6-96231b3b80d8
2016-06-02 02:45:59 +00:00
Vedant Kumar 389648f690 [docs] Minor formatting changes and typo fixes
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@271471 91177308-0d34-0410-b5e6-96231b3b80d8
2016-06-02 02:25:13 +00:00
Vedant Kumar c055111ab2 [docs] Use cpp code-blocks where appropriate
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@271461 91177308-0d34-0410-b5e6-96231b3b80d8
2016-06-02 01:15:59 +00:00
Vedant Kumar f72c4397cf [docs] Add missing newline to console section
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@271457 91177308-0d34-0410-b5e6-96231b3b80d8
2016-06-02 01:01:48 +00:00
Vedant Kumar 81329a49ca [docs] Document the source-based code coverage feature
Differential Revision: http://reviews.llvm.org/D20715

git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@271454 91177308-0d34-0410-b5e6-96231b3b80d8
2016-06-02 00:51:50 +00:00