Skip to content

Commit 67bb160

Browse files
committed
[llvm-profdata] Update CommandGuide
Add a bunch of SampleFDO related flags added recently into llvm-profdata to its command guide. Differential Revision: https://reviews.llvm.org/D79911
1 parent 3a11ca7 commit 67bb160

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

llvm/docs/CommandGuide/llvm-profdata.rst

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,13 @@ OPTIONS
102102
Emit the profile using a binary encoding. For instrumentation-based profile
103103
the output format is the indexed binary format.
104104

105+
.. option:: -extbinary
106+
107+
Emit the profile using an extensible binary encoding. This option can only
108+
be used with sample-based profile. The extensible binary encoding can be
109+
more compact with compression enabled and can be loaded faster than the
110+
default binary encoding.
111+
105112
.. option:: -text
106113

107114
Emit the profile in text mode. This option can also be used with both
@@ -132,6 +139,28 @@ OPTIONS
132139
invalid profiles is excluded from the final merged product. The default
133140
failure mode is 'any'.
134141

142+
.. option:: -prof-sym-list=path
143+
144+
Specify a file which contains a list of symbols to generate profile symbol
145+
list in the profile. This option can only be used with sample-based profile
146+
in extbinary format. The entries in this file are newline-separated.
147+
148+
.. option:: -compress-all-sections=[true|false]
149+
150+
Compress all sections when writing the profile. This option can only be used
151+
with sample-based profile in extbinary format.
152+
153+
.. option:: -use-md5=[true|false]
154+
155+
Use MD5 to represent string in name table when writing the profile.
156+
This option can only be used with sample-based profile in extbinary format.
157+
158+
.. option:: -gen-partial-profile=[true|false]
159+
160+
Mark the profile to be a partial profile which only provides partial profile
161+
coverage for the optimized target. This option can only be used with
162+
sample-based profile in extbinary format.
163+
135164
EXAMPLES
136165
^^^^^^^^
137166
Basic Usage
@@ -242,6 +271,16 @@ OPTIONS
242271
Only show context sensitive profile counts. The default is to filter all
243272
context sensitive profile counts.
244273

274+
.. option:: -show-prof-sym-list=[true|false]
275+
276+
Show profile symbol list if it exists in the profile. This option is only
277+
meaningful for sample-based profile in extbinary format.
278+
279+
.. option:: -show-sec-info-only=[true|false]
280+
281+
Show basic information about each section in the profile. This option is
282+
only meaningful for sample-based profile in extbinary format.
283+
245284
.. program:: llvm-profdata overlap
246285

247286
.. _profdata-overlap:

0 commit comments

Comments
 (0)