summaryrefslogtreecommitdiffstats
path: root/clang/docs/UsersManual.rst
diff options
context:
space:
mode:
authorDiego Novillo <dnovillo@google.com>2015-05-22 16:05:07 +0000
committerDiego Novillo <dnovillo@google.com>2015-05-22 16:05:07 +0000
commite0d289efbdbd918a9fd3e685b14ef48f0c8f28bd (patch)
treef076bee8ec331b991c751075fff03d77f8f34db4 /clang/docs/UsersManual.rst
parent91d8cfd6989e52c9b979652b1d367e1e9c9ff39a (diff)
downloadbcm5719-llvm-e0d289efbdbd918a9fd3e685b14ef48f0c8f28bd.tar.gz
bcm5719-llvm-e0d289efbdbd918a9fd3e685b14ef48f0c8f28bd.zip
Add clarifying note that sampling-based profiles cannot be used for code coverage.
llvm-svn: 238031
Diffstat (limited to 'clang/docs/UsersManual.rst')
-rw-r--r--clang/docs/UsersManual.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/clang/docs/UsersManual.rst b/clang/docs/UsersManual.rst
index 50d5d019255..2a6fc82a90d 100644
--- a/clang/docs/UsersManual.rst
+++ b/clang/docs/UsersManual.rst
@@ -1290,6 +1290,10 @@ If you are not using Linux Perf to collect profiles, you will need to
write a conversion tool from your profiler to LLVM's format. This section
explains the file format expected by the backend.
+NOTE: This format is not intended to be used for code coverage. For that,
+you need to use Clang's instrumentation based profiling
+(``-fprofile-instr-generate``).
+
Sample profiles are written as ASCII text. The file is divided into sections,
which correspond to each of the functions executed at runtime. Each
section has the following format (taken from
OpenPOWER on IntegriCloud