From: Vedant Kumar <vsk@apple.com>
Date: Tue, 14 Jun 2016 00:42:12 +0000 (+0000)
Subject: [docs] Coverage: Document the profile merge pool specifier
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=ade89cd31c31d64bdc1232d68a8390f8e66c3f3b;p=clang

[docs] Coverage: Document the profile merge pool specifier

git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@272604 91177308-0d34-0410-b5e6-96231b3b80d8
---

diff --git a/docs/SourceBasedCodeCoverage.rst b/docs/SourceBasedCodeCoverage.rst
index ff43c931ea..95b2eb692b 100644
--- a/docs/SourceBasedCodeCoverage.rst
+++ b/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.