[clang] Document coverage directory configuration in clang (PR #187512)

[Andrii Zinoviev via cfe-commits]

https://github.com/shivatinker updated https://github.com/llvm/llvm-project/pull/187512

>From e50e18e0a4b42dd2bb109a554faa8018de7fdb44 Mon Sep 17 00:00:00 2001
From: Andrii Zinoviev <negativex228 at gmail.com>
Date: Thu, 19 Mar 2026 15:26:13 +0100
Subject: [PATCH 1/2] Document coverage directory configuration in clang

Added instructions for using the -fprofile-instr-generate parameter to specify a coverage directory at compile-time.
---
 clang/docs/SourceBasedCodeCoverage.rst | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/clang/docs/SourceBasedCodeCoverage.rst b/clang/docs/SourceBasedCodeCoverage.rst
index 395f2bcc85ef0..2e54e2d832302 100644
--- a/clang/docs/SourceBasedCodeCoverage.rst
+++ b/clang/docs/SourceBasedCodeCoverage.rst
@@ -64,6 +64,14 @@ To compile code with coverage enabled, pass ``-fprofile-instr-generate
 Note that linking together code with and without coverage instrumentation is
 supported. Uninstrumented code simply won't be accounted for in reports.
 
+You can also pass the path with ``-fprofile-instr-generate=`` parameter to bake
+the coverage directory at compile-time. Instrumented program will use this path
+for coverage profile, unless ``LLVM_PROFILE_FILE`` environment variable is specified.
+
+.. code-block:: console
+
+    % clang++ -fprofile-instr-generate="foo.profraw" -fcoverage-mapping foo.cc -o foo
+
 To compile code with Modified Condition/Decision Coverage (MC/DC) enabled,
 pass ``-fcoverage-mcdc`` in addition to the clang options specified above.
 MC/DC is an advanced form of code coverage most applicable to the embedded
@@ -74,7 +82,9 @@ Running the instrumented program
 
 The next step is to run the instrumented program. When the program exits, it
 will write a **raw profile** to the path specified by the ``LLVM_PROFILE_FILE``
-environment variable. If that variable does not exist, the profile is written
+environment variable. If that variable does not exist, program will write coverage
+profile to the path specified by ``-fprofile-instr-generate=`` option. If that 
+value does not exist, the profile is written
 to ``default.profraw`` in the current directory of the program. If
 ``LLVM_PROFILE_FILE`` specifies a path to a non-existent directory, the missing
 directory structure will be created.  Additionally, the following special

>From a4a1368a807cddc452e86dbc1c0251d07ede8aa6 Mon Sep 17 00:00:00 2001
From: Andrii Zinoviev <negativex228 at gmail.com>
Date: Wed, 26 Aug 2026 10:41:33 +0200
Subject: [PATCH 2/2] Apply suggestions from code review

Co-authored-by: Alan Phipps <a-phipps at ti.com>
---
 clang/docs/SourceBasedCodeCoverage.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/clang/docs/SourceBasedCodeCoverage.rst b/clang/docs/SourceBasedCodeCoverage.rst
index 2e54e2d832302..1280acd968336 100644
--- a/clang/docs/SourceBasedCodeCoverage.rst
+++ b/clang/docs/SourceBasedCodeCoverage.rst
@@ -64,9 +64,9 @@ To compile code with coverage enabled, pass ``-fprofile-instr-generate
 Note that linking together code with and without coverage instrumentation is
 supported. Uninstrumented code simply won't be accounted for in reports.
 
-You can also pass the path with ``-fprofile-instr-generate=`` parameter to bake
-the coverage directory at compile-time. Instrumented program will use this path
-for coverage profile, unless ``LLVM_PROFILE_FILE`` environment variable is specified.
+You can also pass the filepath with ``-fprofile-instr-generate=`` parameter to bake
+the coverage directory with the **raw profile** at compile-time. Instrumented program will use this path
+for the coverage **raw profile**, unless ``LLVM_PROFILE_FILE`` environment variable is specified.
 
 .. code-block:: console