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

[Aiden Grossman via Phabricator via llvm-commits]

aidengrossman created this revision.
Herald added a subscriber: mstojanovic.
Herald added a project: All.
aidengrossman requested review of this revision.
Herald added subscribers: llvm-commits, courbet.
Herald added a project: LLVM.

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.


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D150536

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


Index: llvm/tools/llvm-exegesis/README.md
===================================================================
--- llvm/tools/llvm-exegesis/README.md
+++ llvm/tools/llvm-exegesis/README.md
@@ -7,17 +7,20 @@
 ### Currently Supported Platforms
 
 `llvm-exegesis` is quite platform-dependent and currently only supports a couple
-platform configurations.
+platform configurations for capture mode. The limiations are listed below.
+`llvm-exegesis` for analysis mode, `llvm-exegesis` is supported on all platforms
+that LLVM itself is supported on.
 
-##### Currently Supported Operating Systems
+#### Currently Supported Operating Systems for Capture Mode
 
-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` capture mode only supports 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 Capture Mode
 
+Currently, `llvm-exegesis` capture mode 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 +29,5 @@
 * MIPS
 * PowerPC (PowerPC64LE only)
 
-Note that not all functionality is guaranteed to work on all architectures.
+Note that not all capture mode functionality is guaranteed to work on all
+platforms.
Index: llvm/docs/CommandGuide/llvm-exegesis.rst
===================================================================
--- llvm/docs/CommandGuide/llvm-exegesis.rst
+++ llvm/docs/CommandGuide/llvm-exegesis.rst
@@ -34,8 +34,10 @@
 -------------------
 
 :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 capture mode (collecting
+performance data). Not all capture mode functionality is guaranteed to work on
+every platform. :program:`llvm-exegesis` also has a separate analysis mode that
+is supported on all platforms that LLVM is.
 
 SNIPPET ANNOTATIONS
 -------------------


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D150536.522047.patch
Type: text/x-patch
Size: 2340 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20230515/8b603080/attachment.bin>