[llvm] r329732 - [llvm-mca] reorder text

Sanjay Patel via llvm-commits llvm-commits at lists.llvm.org
Tue Apr 10 11:10:14 PDT 2018


Author: spatel
Date: Tue Apr 10 11:10:14 2018
New Revision: 329732

URL: http://llvm.org/viewvc/llvm-project?rev=329732&view=rev
Log:
[llvm-mca] reorder text

On 2nd reading, putting the C example after the bit about
multiple regions makes this flow better.

Modified:
    llvm/trunk/docs/CommandGuide/llvm-mca.rst

Modified: llvm/trunk/docs/CommandGuide/llvm-mca.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-mca.rst?rev=329732&r1=329731&r2=329732&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-mca.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-mca.rst Tue Apr 10 11:10:14 2018
@@ -36,7 +36,14 @@ substring ``LLVM-MCA-END`` marks the end
     ...
   # LLVM-MCA-END
 
-Inline assembly directives may also be used from source code to annotate the 
+Multiple regions can be specified provided that they do not overlap.  A code
+region can have an optional description. If no user-defined region is specified,
+then :program:`llvm-mca` assumes a default region which contains every
+instruction in the input file.  Every region is analyzed in isolation, and the
+final performance report is the union of all the reports generated for every
+code region.
+
+Inline assembly directives may be used from source code to annotate the 
 assembly text:
 
 .. code-block:: c++
@@ -54,14 +61,7 @@ directly into llvm-mca for analysis:
 
 .. code-block:: bash
 
-  $ clang foo.cpp -O2 -target x86_64-unknown-unknown -S -o - | llvm-mca -mcpu=btver2
-
-Multiple regions can be specified provided that they do not overlap.  A code
-region can have an optional description. If no user defined region is specified,
-then :program:`llvm-mca` assumes a default region which contains every
-instruction in the input file.  Every region is analyzed in isolation, and the
-final performance report is the union of all the reports generated for every
-code region.
+  $ clang foo.c -O2 -target x86_64-unknown-unknown -S -o - | llvm-mca -mcpu=btver2
 
 OPTIONS
 -------




More information about the llvm-commits mailing list