[llvm] c19bc61 - [Docs][llvm-exegesis] Add documentation for --use-dummy-perf-counters

[Aiden Grossman via llvm-commits]

Author: Aiden Grossman
Date: 2023-04-10T19:09:35Z
New Revision: c19bc611bdea30ff0ea6be004be93229c732d5bf

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

LOG: [Docs][llvm-exegesis] Add documentation for --use-dummy-perf-counters

This patch adds in documentation for the --use-dummy-perf-counters
option (introduced in D146301).

Reviewed By: kpdev42

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

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 c4ffe8d76d5c2..bede7d2a9d7a9 100644
--- a/llvm/docs/CommandGuide/llvm-exegesis.rst
+++ b/llvm/docs/CommandGuide/llvm-exegesis.rst
@@ -362,6 +362,13 @@ OPTIONS
  If set,  llvm-exegesis will dump the generated code to a temporary file to
  enable code inspection. Disabled by default.
 
+.. option:: --use-dummy-perf-counters
+
+ If set, llvm-exegesis will not read any real performance counters and
+ return a dummy value instead. This can be used to ensure a snippet doesn't
+ crash when hardware performance counters are unavailable and for
+ debugging :program:`llvm-exegesis` itself.
+
 EXIT STATUS
 -----------