Skip to content

Commit aef39f5

Browse files
authored
[Clang][PGO][UserManual] Specify usage of -b flag (#139763)
llvm-profgen cannot accept the perf profiles collected without `-b` and errors out with a message `"Invalid perf script input!"`. This can also be validated from the code in function `checkPerfScriptType()` in `tools/llvm-profgen/PerfReader.cpp.`
1 parent e29b70e commit aef39f5

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

clang/docs/UsersManual.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2792,6 +2792,9 @@ usual build cycle when using sample profilers for optimization:
27922792
27932793
$ llvm-profgen --binary=./code --output=code.prof --perfdata=perf.data
27942794
2795+
Please note, ``perf.data`` must be collected with ``-b`` flag to Linux ``perf``
2796+
for the above step to work.
2797+
27952798
When using SEP the output is in the textual format corresponding to
27962799
``llvm-profgen --perfscript``. For example:
27972800

0 commit comments

Comments
 (0)