diff options
| author | Vedant Kumar <vsk@apple.com> | 2017-09-25 23:10:04 +0000 |
|---|---|---|
| committer | Vedant Kumar <vsk@apple.com> | 2017-09-25 23:10:04 +0000 |
| commit | ab0b78f63420c41ee4c082df750163d99f3518a9 (patch) | |
| tree | 2da892399178df81fa7d0c8b7fa3d40cceed2feb /docs/CommandGuide | |
| parent | 35ccd0b31ce4a4f291cc81907b6ea944406ca703 (diff) | |
[docs] llvm-cov: Make docs for boolean options more consistent
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@314176 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/CommandGuide')
| -rw-r--r-- | docs/CommandGuide/llvm-cov.rst | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/docs/CommandGuide/llvm-cov.rst b/docs/CommandGuide/llvm-cov.rst index 3b64141e7365..6ee05ee1a0a8 100644 --- a/docs/CommandGuide/llvm-cov.rst +++ b/docs/CommandGuide/llvm-cov.rst @@ -195,31 +195,32 @@ OPTIONS .. option:: -show-line-counts - Show the execution counts for each line. This is enabled by default, unless - another ``-show`` option is used. + Show the execution counts for each line. Defaults to true, unless another + ``-show`` option is used. .. option:: -show-expansions Expand inclusions, such as preprocessor macros or textual inclusions, inline - in the display of the source file. + in the display of the source file. Defaults to false. .. option:: -show-instantiations For source regions that are instantiated multiple times, such as templates in ``C++``, show each instantiation separately as well as the combined summary. - This option is enabled by default. + Defaults to true. .. option:: -show-regions Show the execution counts for each region by displaying a caret that points to - the character where the region starts. + the character where the region starts. Defaults to false. .. option:: -show-line-counts-or-regions Show the execution counts for each line if there is only one region on the line, but show the individual regions if there are multiple on the line. + Defaults to false. -.. option:: -use-color[=VALUE] +.. option:: -use-color Enable or disable color output. By default this is autodetected. @@ -344,9 +345,9 @@ OPTIONS .. option:: -show-functions - Show coverage summaries for each function. + Show coverage summaries for each function. Defaults to false. -.. option:: -show-instantiation-summary=[VALUE] +.. option:: -show-instantiation-summary Show statistics for all function instantiations. Defaults to false. |