[llvm] 1d0f4a8 - [Docs] Update llvm-test-suite PGO instructions to use LLVM IR PGO by

[Mingming Liu via llvm-commits]

Author: Mingming Liu
Date: 2023-06-20T12:17:55-07:00
New Revision: 1d0f4a86855b372c3c646ac2aa88c2cdc7168593

URL: https://github.com/llvm/llvm-project/commit/1d0f4a86855b372c3c646ac2aa88c2cdc7168593
DIFF: https://github.com/llvm/llvm-project/commit/1d0f4a86855b372c3c646ac2aa88c2cdc7168593.diff

LOG: [Docs] Update llvm-test-suite PGO instructions to use LLVM IR PGO by
default.

- Currently, the default instructions will use Clang's frontend PGO
  feature.

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

Added: 
    

Modified: 
    llvm/docs/TestSuiteGuide.md

Removed: 
    


################################################################################
diff  --git a/llvm/docs/TestSuiteGuide.md b/llvm/docs/TestSuiteGuide.md
index 9244dea6e7804..e09d7d8803c72 100644
--- a/llvm/docs/TestSuiteGuide.md
+++ b/llvm/docs/TestSuiteGuide.md
@@ -336,8 +336,9 @@ using `llvm-profdata` so they can be used by the second compilation run.
 
 Example:
 ```bash
-# Profile generation run:
+# Profile generation run using LLVM IR PGO:
 % cmake -DTEST_SUITE_PROFILE_GENERATE=ON \
+        -DTEST_SUITE_USE_IR_PGO=ON \
         -DTEST_SUITE_RUN_TYPE=train \
         ../test-suite
 % make
@@ -351,6 +352,8 @@ Example:
 % llvm-lit -o result.json .
 ```
 
+To use Clang frontend's PGO instead of LLVM IR PGO, set `-DTEST_SUITE_USE_IR_PGO=OFF`.
+
 The `TEST_SUITE_RUN_TYPE` setting only affects the SPEC benchmark suites.