[llvm] 24ff23f - [llvm-exegesis][Docs] Add documentation on benchmark-process-cpu option

[Aiden Grossman via llvm-commits]

Author: Aiden Grossman
Date: 2024-12-24T21:54:30Z
New Revision: 24ff23fb3af95bb3a2e5af1e95f94a3e308a5a6a

URL: https://github.com/llvm/llvm-project/commit/24ff23fb3af95bb3a2e5af1e95f94a3e308a5a6a
DIFF: https://github.com/llvm/llvm-project/commit/24ff23fb3af95bb3a2e5af1e95f94a3e308a5a6a.diff

LOG: [llvm-exegesis][Docs] Add documentation on benchmark-process-cpu option

This patch adds documentation on the benchmark-process-cpu option. I
apparently did not add any documentation when originally implementing
the feature.

Added: 
    

Modified: 
    llvm/docs/CommandGuide/llvm-exegesis.rst

Removed: 
    


################################################################################
diff  --git a/llvm/docs/CommandGuide/llvm-exegesis.rst b/llvm/docs/CommandGuide/llvm-exegesis.rst
index c2681535b566e8..8266d891a5e6b1 100644
--- a/llvm/docs/CommandGuide/llvm-exegesis.rst
+++ b/llvm/docs/CommandGuide/llvm-exegesis.rst
@@ -473,6 +473,14 @@ OPTIONS
    flag can be specified multiple times to measure multiple events. The maximum
    number of validation counters is platform dependent.
 
+.. option:: --benchmark-process-cpu=<cpu id>
+
+  This option specifies the number of the CPU that should be used to run the
+  benchmarking subprocess. When starting the subprocess,
+  :program:`llvm-exegesis` will set the affinity of the subprocess to only
+  include the specified CPU. This option only works in the subprocess execution
+  mode.
+
 EXIT STATUS
 -----------