This is an archive of the discontinued LLVM Phabricator instance.

Differential D105826

[docs/llvm-cov] Document -compilation-dir
ClosedPublic

Authored by vsk on Jul 12 2021, 9:41 AM.

Details

Reviewers
phosek
zequanwu
Commits
rG5105a77035d0: [docs/llvm-cov] Document -compilation-dir
Summary

Document the -compilation-dir option added in D100232.

Diff Detail

Event Timeline

vsk requested review of this revision.Jul 12 2021, 9:41 AM
vsk created this revision.
Herald added a project: Restricted Project. · View Herald TranscriptJul 12 2021, 9:41 AM
zequanwu added inline comments.Jul 12 2021, 10:43 AM
llvm/docs/CommandGuide/llvm-cov.rst
317

Binaries compiled with -ffile-compilation-dir= would also have compilation directory set for coverage mapping. The flag set both -fcoverage-compilation-dir and -fdebug-compilation-dir.

Harbormaster completed remote builds in B113521: Diff 357968.Jul 12 2021, 10:51 AM
vsk updated this revision to Diff 358313.Jul 13 2021, 9:44 AM

Include -ffile-compilation-dir.

Harbormaster completed remote builds in B113770: Diff 358313.Jul 13 2021, 10:59 AM
phosek accepted this revision.Jul 13 2021, 11:45 AM

LGTM

This revision is now accepted and ready to land.Jul 13 2021, 11:45 AM
This revision was landed with ongoing or failed builds.Jul 13 2021, 1:10 PM
Closed by commit rG5105a77035d0: [docs/llvm-cov] Document -compilation-dir (authored by vsk). · Explain Why
This revision was automatically updated to reflect the committed changes.
vsk added a commit: rG5105a77035d0: [docs/llvm-cov] Document -compilation-dir.

Revision Contents

PathSize
llvm/
docs/
CommandGuide/
18 lines

Diff 358405

llvm/docs/CommandGuide/llvm-cov.rst

Show First 20 Lines • Show All 304 Lines • ▼ Show 20 Lines
stdin and write a newline-separated list of the same length to stdout. stdin and write a newline-separated list of the same length to stdout.
.. option:: -num-threads=N, -j=N .. option:: -num-threads=N, -j=N
Use N threads to write file reports (only applicable when -output-dir is 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 specified). When N=0, llvm-cov auto-detects an appropriate number of threads to
use. This is the default. use. This is the default.
.. option:: -compilation-dir=<dir>
Directory used as a base for relative coverage mapping paths. Only applicable
when binaries have been compiled with one of `-fcoverage-prefix-map`
`-fcoverage-compilation-dir`, or `-ffile-compilation-dir`.
zequanwuUnsubmitted
Not Done
ReplyInline Actions

Binaries compiled with -ffile-compilation-dir= would also have compilation directory set for coverage mapping. The flag set both -fcoverage-compilation-dir and -fdebug-compilation-dir.

zequanwu: Binaries compiled with `-ffile-compilation-dir=` would also have compilation directory set for…
.. option:: -line-coverage-gt=<N> .. option:: -line-coverage-gt=<N>
Show code coverage only for functions with line coverage greater than the Show code coverage only for functions with line coverage greater than the
given threshold. given threshold.
.. option:: -line-coverage-lt=<N> .. option:: -line-coverage-lt=<N>
Show code coverage only for functions with line coverage less than the given Show code coverage only for functions with line coverage less than the given
▲ Show 20 Lines • Show All 73 Lines • ▼ Show 20 Lines
.. option:: -show-instantiation-summary .. option:: -show-instantiation-summary
Show statistics for all function instantiations. Defaults to false. Show statistics for all function instantiations. Defaults to false.
.. option:: -ignore-filename-regex=<PATTERN> .. option:: -ignore-filename-regex=<PATTERN>
Skip source code files with file paths that match the given regular expression. Skip source code files with file paths that match the given regular expression.
.. option:: -compilation-dir=<dir>
Directory used as a base for relative coverage mapping paths. Only applicable
when binaries have been compiled with one of `-fcoverage-prefix-map`
`-fcoverage-compilation-dir`, or `-ffile-compilation-dir`.
.. program:: llvm-cov export .. program:: llvm-cov export
.. _llvm-cov-export: .. _llvm-cov-export:
EXPORT COMMAND EXPORT COMMAND
-------------- --------------
SYNOPSIS SYNOPSIS
▲ Show 20 Lines • Show All 52 Lines • ▼ Show 20 Lines
.. option:: -skip-functions .. option:: -skip-functions
Skip exporting per-function coverage data. Skip exporting per-function coverage data.
.. option:: -num-threads=N, -j=N .. option:: -num-threads=N, -j=N
Use N threads to export coverage data. When N=0, llvm-cov auto-detects an Use N threads to export coverage data. When N=0, llvm-cov auto-detects an
appropriate number of threads to use. This is the default. appropriate number of threads to use. This is the default.
.. option:: -compilation-dir=<dir>
Directory used as a base for relative coverage mapping paths. Only applicable
when binaries have been compiled with one of `-fcoverage-prefix-map`
`-fcoverage-compilation-dir`, or `-ffile-compilation-dir`.