[llvm] 05cca8a - [Docs][llvm-exegesis] Specify platform support for different modes

[Aiden Grossman via llvm-commits]

Author: Aiden Grossman
Date: 2023-05-16T03:28:06Z
New Revision: 05cca8a1bc82aae1933c0e332a4d774cadc9f330

URL: https://github.com/llvm/llvm-project/commit/05cca8a1bc82aae1933c0e332a4d774cadc9f330
DIFF: https://github.com/llvm/llvm-project/commit/05cca8a1bc82aae1933c0e332a4d774cadc9f330.diff

LOG: [Docs][llvm-exegesis] Specify platform support for different modes

llvm-exegesis has both a capture mode and an analysis mode that can be
used independently of each other. This patch makes it clear that
analysis mode will work on other platforms that LLVM supports in the
documentation which was unclear before.

Reviewed By: courbet

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

Added: 
    

Modified: 
    llvm/docs/CommandGuide/llvm-exegesis.rst
    llvm/tools/llvm-exegesis/README.md

Removed: 
    


################################################################################
diff  --git a/llvm/docs/CommandGuide/llvm-exegesis.rst b/llvm/docs/CommandGuide/llvm-exegesis.rst
index f6f2e2710d2b1..7fdce24e01114 100644
--- a/llvm/docs/CommandGuide/llvm-exegesis.rst
+++ b/llvm/docs/CommandGuide/llvm-exegesis.rst
@@ -34,8 +34,10 @@ SUPPORTED PLATFORMS
 -------------------
 
 :program:`llvm-exegesis` currently only supports X86 (64-bit only), ARM (AArch64
-only), MIPS, and PowerPC (PowerPC64LE only) on Linux. Not all functionality is
-guaranteed to work on every platform.
+only), MIPS, and PowerPC (PowerPC64LE only) on Linux for benchmarking. Not all
+benchmarking functionality is guaranteed to work on every platform.
+:program:`llvm-exegesis` also has a separate analysis mode that is supported
+on every platform on which LLVM is.
 
 SNIPPET ANNOTATIONS
 -------------------

diff  --git a/llvm/tools/llvm-exegesis/README.md b/llvm/tools/llvm-exegesis/README.md
index c478b56586b83..6f2d3a9c48774 100644
--- a/llvm/tools/llvm-exegesis/README.md
+++ b/llvm/tools/llvm-exegesis/README.md
@@ -7,17 +7,19 @@ of performance counters.
 ### Currently Supported Platforms
 
 `llvm-exegesis` is quite platform-dependent and currently only supports a couple
-platform configurations.
+platform configurations for benchmarking. The limitations are listed below.
+Analysis mode in `llvm-exegesis` is supported on all platforms on which LLVM is.
 
-##### Currently Supported Operating Systems
+#### Currently Supported Operating Systems for Benchmarking
 
-Currently, `llvm-exegesis` only supports Linux. This is mainly due to a
-dependency on the Linux perf subsystem for reading performance counters.
+Currently, `llvm-exegesis`  only supports benchmarking on Linux. This is mainly
+due to a dependency on the Linux perf subsystem for reading performance
+counters.
 
-##### Currently Supported Architectures
-
-Currently, `llvm-exegesis` supports the following architectures:
+#### Currently Supported Architectures for Benchmarking
 
+Currently, using `llvm-exegesis` for benchmarking is supported on the following
+architectures:
 * x86
   * 64-bit only due to this being the only implemented calling convention
     in `llvm-exegesis` currently.
@@ -26,4 +28,4 @@ Currently, `llvm-exegesis` supports the following architectures:
 * MIPS
 * PowerPC (PowerPC64LE only)
 
-Note that not all functionality is guaranteed to work on all architectures.
+Note that not benchmarking functionality is guaranteed to work on all platforms.