[clang][doc] Simplify Sampling-PGO use example #162588
Merged
+10
−8
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The -fprofile-sample-use implies codegenoptions::LocTrackingOnly. No need to explicitly specify -g if debug info is not required in final binary. Also fix -fuse-ld=lld.
|
@llvm/pr-subscribers-clang Author: Haohai Wen (HaohaiWen) ChangesThe -fprofile-sample-use implies codegenoptions::LocTrackingOnly. No need Also fix -fuse-ld=lld. Full diff: https://github.com/llvm/llvm-project/pull/162588.diff 1 Files Affected:
diff --git a/clang/docs/UsersManual.rst b/clang/docs/UsersManual.rst
index 12c2ada062625..94f517829fc24 100644
--- a/clang/docs/UsersManual.rst
+++ b/clang/docs/UsersManual.rst
@@ -2778,7 +2778,7 @@ usual build cycle when using sample profilers for optimization:
> clang-cl /O2 -gdwarf -gline-tables-only ^
/clang:-fdebug-info-for-profiling /clang:-funique-internal-linkage-names ^
- code.cc /Fe:code /fuse-ld=lld /link /debug:dwarf
+ code.cc /Fe:code -fuse-ld=lld /link /debug:dwarf
.. note::
@@ -2867,7 +2867,7 @@ usual build cycle when using sample profilers for optimization:
.. code-block:: console
- $ clang++ -O2 -gline-tables-only \
+ $ clang++ -O2 \
-fdebug-info-for-profiling -funique-internal-linkage-names \
-fprofile-sample-use=code.prof code.cc -o code
@@ -2875,7 +2875,7 @@ usual build cycle when using sample profilers for optimization:
.. code-block:: winbatch
- > clang-cl /O2 -gdwarf -gline-tables-only ^
+ > clang-cl /O2 ^
/clang:-fdebug-info-for-profiling /clang:-funique-internal-linkage-names ^
-fprofile-sample-use=code.prof code.cc /Fe:code -fuse-ld=lld /link /debug:dwarf
@@ -2886,7 +2886,7 @@ usual build cycle when using sample profilers for optimization:
.. code-block:: console
- $ clang++ -fsample-profile-use-profi -O2 -gline-tables-only \
+ $ clang++ -fsample-profile-use-profi -O2 \
-fdebug-info-for-profiling -funique-internal-linkage-names \
-fprofile-sample-use=code.prof code.cc -o code
@@ -2894,7 +2894,7 @@ usual build cycle when using sample profilers for optimization:
.. code-block:: winbatch
- > clang-cl /clang:-fsample-profile-use-profi /O2 -gdwarf -gline-tables-only ^
+ > clang-cl /clang:-fsample-profile-use-profi /O2 ^
/clang:-fdebug-info-for-profiling /clang:-funique-internal-linkage-names ^
-fprofile-sample-use=code.prof code.cc /Fe:code -fuse-ld=lld /link /debug:dwarf
|
clang/docs/UsersManual.rst
Outdated
| > clang-cl /O2 -gdwarf -gline-tables-only ^ | ||
| > clang-cl /O2 ^ | ||
| /clang:-fdebug-info-for-profiling /clang:-funique-internal-linkage-names ^ | ||
| -fprofile-sample-use=code.prof code.cc /Fe:code -fuse-ld=lld /link /debug:dwarf |
There was a problem hiding this comment.
If we don't want DWARF in the binary can we also emit some of the link options like -fuse-ld=lld and /link /debug:dwarf?
tcreech-intel
approved these changes
Oct 10, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The -fprofile-sample-use implies codegenoptions::LocTrackingOnly. No need
to explicitly specify -g if debug info is not required in final binary.
Also fix -fuse-ld=lld.