[llvm] d635695 - [DebugInfo][Docs] Fix RST syntax for DW_OP_LLVM_arg in LangRef

J. Ryan Stinnett via llvm-commits llvm-commits at lists.llvm.org
Mon Sep 12 04:49:22 PDT 2022


Author: J. Ryan Stinnett
Date: 2022-09-12T12:49:05+01:00
New Revision: d635695cf80b3c4d2f5439d082fafcaa4f2a3fef

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

LOG: [DebugInfo][Docs] Fix RST syntax for DW_OP_LLVM_arg in LangRef

The inline code in the description of `DW_OP_LLVM_arg` wasn't terminating
correctly, leading to more text displayed as code than intended. This fixes that
up and adds a superscript as a tiny embellishment.

Added: 
    

Modified: 
    llvm/docs/LangRef.rst

Removed: 
    


################################################################################
diff  --git a/llvm/docs/LangRef.rst b/llvm/docs/LangRef.rst
index 1c89878e37f80..73ab0ef1f3a69 100644
--- a/llvm/docs/LangRef.rst
+++ b/llvm/docs/LangRef.rst
@@ -5813,7 +5813,7 @@ The current supported opcode vocabulary is limited:
 - ``DW_OP_LLVM_arg, N`` is used in debug intrinsics that refer to more than one
   value, such as one that calculates the sum of two registers. This is always
   used in combination with an ordered list of values, such that
-  ``DW_OP_LLVM_arg, N`` refers to the ``N``th element in that list. For
+  ``DW_OP_LLVM_arg, N`` refers to the ``N``\ :sup:`th` element in that list. For
   example, ``!DIExpression(DW_OP_LLVM_arg, 0, DW_OP_LLVM_arg, 1, DW_OP_minus,
   DW_OP_stack_value)`` used with the list ``(%reg1, %reg2)`` would evaluate to
   ``%reg1 - reg2``. This list of values should be provided by the containing


        


More information about the llvm-commits mailing list