[llvm] 89a6647 - [llvm-exegesis] Document `repetition-mode`.

[Clement Courbet via llvm-commits]

Author: Clement Courbet
Date: 2020-02-06T13:42:12+01:00
New Revision: 89a66474b6c1e5843c3dbc96bde52e5a7076c6cc

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

LOG: [llvm-exegesis] Document `repetition-mode`.

Reviewers: gchatelet

Subscribers: tschuett, mstojanovic, llvm-commits

Tags: #llvm

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

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 81e92e7736d6..0a5b0990d2ee 100644
--- a/llvm/docs/CommandGuide/llvm-exegesis.rst
+++ b/llvm/docs/CommandGuide/llvm-exegesis.rst
@@ -184,10 +184,10 @@ OPTIONS
  a comma-separated list. See example 1 for details.
  Either `opcode-index`, `opcode-name` or `snippets-file` must be set.
 
- .. option:: -snippets-file=<filename>
+.. option:: -snippets-file=<filename>
 
-  Specify the custom code snippet to measure. See example 2 for details.
-  Either `opcode-index`, `opcode-name` or `snippets-file` must be set.
+ Specify the custom code snippet to measure. See example 2 for details.
+ Either `opcode-index`, `opcode-name` or `snippets-file` must be set.
 
 .. option:: -mode=[latency|uops|inverse_throughput|analysis]
 
@@ -195,6 +195,15 @@ OPTIONS
  to specify at least one of the `-analysis-clusters-output-file=` and
  `-analysis-inconsistencies-output-file=`.
 
+.. option:: -repetition-mode=[duplicate|loop]
+
+ Specify the repetition mode. `duplicate` will create a large, straight line
+ basic block with `num-repetitions` copies of the snippet. `loop` will wrap
+ the snippet in a loop which will be run `num-repetitions` times. The `loop`
+ mode tends to better hide the effects of the CPU frontend on architectures
+ that cache decoded instructions, but consumes a register for counting
+ iterations.
+
 .. option:: -num-repetitions=<Number of repetitions>
 
  Specify the number of repetitions of the asm snippet.