[clang] 56e36e4 - [UsersManual] Add llvm-progen as an alternative tool for AutoFDO profile generation.

[Hongtao Yu via cfe-commits]

Author: Hongtao Yu
Date: 2023-06-20T13:26:30-07:00
New Revision: 56e36e47f50446f519dfa2132cf5a49cc0816866

URL: https://github.com/llvm/llvm-project/commit/56e36e47f50446f519dfa2132cf5a49cc0816866
DIFF: https://github.com/llvm/llvm-project/commit/56e36e47f50446f519dfa2132cf5a49cc0816866.diff

LOG: [UsersManual] Add llvm-progen as an alternative tool for AutoFDO profile generation.

I'm adding llvm-profgen as an alternative AutoFDO profile generator to the user manual. llvm-profgen is widely used and tested by META as their default profile generator.

Reviewed By: davidxl

Differential Revision: https://reviews.llvm.org/D142994

Added: 
    

Modified: 
    clang/docs/UsersManual.rst

Removed: 
    


################################################################################
diff  --git a/clang/docs/UsersManual.rst b/clang/docs/UsersManual.rst
index f8dbf819d6ff7..6a644eed6d32b 100644
--- a/clang/docs/UsersManual.rst
+++ b/clang/docs/UsersManual.rst
@@ -2400,6 +2400,14 @@ usual build cycle when using sample profilers for optimization:
    without the ``-b`` flag, you need to use ``--use_lbr=false`` when
    calling ``create_llvm_prof``.
 
+   Alternatively, the LLVM tool ``llvm-profgen`` can also be used to generate
+   the LLVM sample profile:
+
+   .. code-block:: console
+
+     $ llvm-profgen --binary=./code --output=code.prof--perfdata=perf.data
+
+
 4. Build the code again using the collected profile. This step feeds
    the profile back to the optimizers. This should result in a binary
    that executes faster than the original one. Note that you are not