Mercurial > hg > CbC > CbC_llvm
diff docs/CommandGuide/llvm-cov.rst @ 121:803732b1fca8
LLVM 5.0
author | kono |
---|---|
date | Fri, 27 Oct 2017 17:07:41 +0900 |
parents | 1172e4bd9c6f |
children | 3a76565eade5 |
line wrap: on
line diff
--- a/docs/CommandGuide/llvm-cov.rst Fri Nov 25 19:14:25 2016 +0900 +++ b/docs/CommandGuide/llvm-cov.rst Fri Oct 27 17:07:41 2017 +0900 @@ -195,44 +195,53 @@ .. 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. + 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. -.. option:: -arch=<name> +.. option:: -arch=[*NAMES*] - If the covered binary is a universal binary, select the architecture to use. - It is an error to specify an architecture that is not included in the - universal binary or to use an architecture that does not match a - non-universal binary. + Specify a list of architectures such that the Nth entry in the list + corresponds to the Nth specified binary. If the covered object is a universal + binary, this specifies the architecture to use. It is an error to specify an + architecture that is not included in the universal binary or to use an + architecture that does not match a non-universal binary. .. option:: -name=<NAME> Show code coverage only for functions with the given name. +.. option:: -name-whitelist=<FILE> + + Show code coverage only for functions listed in the given file. Each line in + the file should start with `whitelist_fun:`, immediately followed by the name + of the function to accept. This name can be a wildcard expression. + .. option:: -name-regex=<PATTERN> Show code coverage only for functions that match the given regular expression. @@ -262,6 +271,12 @@ The demangler is expected to read a newline-separated list of symbols from stdin and write a newline-separated list of the same length to stdout. +.. option:: -num-threads=N, -j=N + + Use N threads to write file reports (only applicable when -output-dir is + specified). When N=0, llvm-cov auto-detects an appropriate number of threads to + use. This is the default. + .. option:: -line-coverage-gt=<N> Show code coverage only for functions with line coverage greater than the @@ -282,6 +297,12 @@ Show code coverage only for functions with region coverage less than the given threshold. +.. option:: -path-equivalence=<from>,<to> + + Map the paths in the coverage data to local source file paths. This allows you + to generate the coverage data on one machine, and then use llvm-cov on a + different machine where you have the same files on a different path. + .. program:: llvm-cov report .. _llvm-cov-report: @@ -322,6 +343,14 @@ universal binary or to use an architecture that does not match a non-universal binary. +.. option:: -show-functions + + Show coverage summaries for each function. Defaults to false. + +.. option:: -show-instantiation-summary + + Show statistics for all function instantiations. Defaults to false. + .. program:: llvm-cov export .. _llvm-cov-export: