[llvm] 85bff00 - Fix: Title underline too short in D129372

Stephen Tozer via llvm-commits llvm-commits at lists.llvm.org
Fri Jan 6 10:23:47 PST 2023


Author: Stephen Tozer
Date: 2023-01-06T18:22:02Z
New Revision: 85bff00c73e5297be6abad255856b2ea079adabb

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

LOG: Fix: Title underline too short in D129372

This patch fixes an error in commit e10e9363 in which the
added documentation contained an incorrectly-styled underline
for the title "Debug Instruction Reference Operands".

Added: 
    

Modified: 
    llvm/docs/MIRLangRef.rst

Removed: 
    


################################################################################
diff  --git a/llvm/docs/MIRLangRef.rst b/llvm/docs/MIRLangRef.rst
index db8b275f502c8..cd7819ed5c7f0 100644
--- a/llvm/docs/MIRLangRef.rst
+++ b/llvm/docs/MIRLangRef.rst
@@ -460,7 +460,7 @@ is preferred.
 Machine Operands
 ----------------
 
-There are eighteen 
diff erent kinds of machine operands, and all of them can be
+There are eighteen 
diff erent kinds of machine operands, and all of them can be
 serialized.
 
 Immediate Operands
@@ -736,19 +736,19 @@ The syntax is:
 
     EH_LABEL <mcsymbol Ltmp1>
 
-Debug Instruction Reference Operands
-^^^^^^^^^^^^^^^^^
-
-A debug instruction reference operand is a pair of indices, referring to an
-instruction and an operand within that instruction respectively; see
-:ref:`Instruction referencing locations <instruction-referencing-locations>`.
-
-The example below uses a reference to Instruction 1, Operand 0:
-
-.. code-block:: text
-
-    DBG_INSTR_REF !123, !DIExpression(), dbg-instr-ref(1, 0), debug-location !456
-
+Debug Instruction Reference Operands
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+A debug instruction reference operand is a pair of indices, referring to an
+instruction and an operand within that instruction respectively; see
+:ref:`Instruction referencing locations <instruction-referencing-locations>`.
+
+The example below uses a reference to Instruction 1, Operand 0:
+
+.. code-block:: text
+
+    DBG_INSTR_REF !123, !DIExpression(), dbg-instr-ref(1, 0), debug-location !456
+
 CFIIndex Operands
 ^^^^^^^^^^^^^^^^^
 
@@ -899,8 +899,8 @@ variable. The second operand (``IsIndirect``) is deprecated and to be deleted.
 All additional qualifiers for the variable location should be made through the
 expression metadata.
 
-.. _instruction-referencing-locations:
-
+.. _instruction-referencing-locations:
+
 Instruction referencing locations
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -913,16 +913,16 @@ instruction number and operand number. Consider the example below:
 .. code-block:: text
 
     $rbp = MOV64ri 0, debug-instr-number 1, debug-location !12
-    DBG_INSTR_REF !123, !DIExpression(), dbg-instr-ref(1, 0), debug-location !456
+    DBG_INSTR_REF !123, !DIExpression(), dbg-instr-ref(1, 0), debug-location !456
 
 Instruction numbers are directly attached to machine instructions with an
 optional ``debug-instr-number`` attachment, before the optional
 ``debug-location`` attachment. The value defined in ``$rbp`` in the code
 above would be identified by the pair ``<1, 0>``.
 
-The 3rd operand of the ``DBG_INSTR_REF`` above records the instruction
+The 3rd operand of the ``DBG_INSTR_REF`` above records the instruction
 and operand number ``<1, 0>``, identifying the value defined by the ``MOV64ri``.
-The first two operands to ``DBG_INSTR_REF`` are identical to ``DBG_VALUE_LIST``,
+The first two operands to ``DBG_INSTR_REF`` are identical to ``DBG_VALUE_LIST``,
 and the ``DBG_INSTR_REF`` s position records where the variable takes on the
 designated value in the same way.
 


        


More information about the llvm-commits mailing list