diff --git a/llvm/docs/CommandGuide/llvm-exegesis.rst b/llvm/docs/CommandGuide/llvm-exegesis.rst --- a/llvm/docs/CommandGuide/llvm-exegesis.rst +++ b/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 ------------------- diff --git a/llvm/tools/llvm-exegesis/README.md b/llvm/tools/llvm-exegesis/README.md --- a/llvm/tools/llvm-exegesis/README.md +++ b/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.