summaryrefslogtreecommitdiffstats
path: root/clang/docs/SourceBasedCodeCoverage.rst
diff options
context:
space:
mode:
authorVedant Kumar <vsk@apple.com>2016-06-14 00:42:12 +0000
committerVedant Kumar <vsk@apple.com>2016-06-14 00:42:12 +0000
commitf3300c9f7489fc6a42c78c16bf8fbed9ba84dcd1 (patch)
treea7d5d36ca79b7acb1b94144c25e4f4995f05f99b /clang/docs/SourceBasedCodeCoverage.rst
parent7d5a57cbfce1cb5567c7bc9c5c4c018eaf5cf392 (diff)
downloadbcm5719-llvm-f3300c9f7489fc6a42c78c16bf8fbed9ba84dcd1.tar.gz
bcm5719-llvm-f3300c9f7489fc6a42c78c16bf8fbed9ba84dcd1.zip
[docs] Coverage: Document the profile merge pool specifier
llvm-svn: 272604
Diffstat (limited to 'clang/docs/SourceBasedCodeCoverage.rst')
-rw-r--r--clang/docs/SourceBasedCodeCoverage.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/clang/docs/SourceBasedCodeCoverage.rst b/clang/docs/SourceBasedCodeCoverage.rst
index ff43c931ea2..95b2eb692ba 100644
--- a/clang/docs/SourceBasedCodeCoverage.rst
+++ b/clang/docs/SourceBasedCodeCoverage.rst
@@ -78,6 +78,14 @@ directory structure will be created. Additionally, the following special
* "%h" expands out to the hostname of the machine running the program.
+* "%Nm" expands out to the instrumented binary's signature. When this pattern
+ is specified, the runtime creates a pool of N raw profiles which are used for
+ on-line profile merging. The runtime takes care of selecting a raw profile
+ from the pool, locking it, and updating it before the program exits. If N is
+ not specified (i.e the pattern is "%m"), it's assumed that ``N = 1``. N must
+ be between 1 and 9. The merge pool specifier can only occur once per filename
+ pattern.
+
.. code-block:: console
# Step 2: Run the program.
OpenPOWER on IntegriCloud