From ee30ab7184f54df3f2539b4648c2b5a94a507f5e Mon Sep 17 00:00:00 2001
From: Francis Visoiu Mistrih <francisvm@yahoo.com>
Date: Thu, 14 Dec 2017 10:03:23 +0000
Subject: [CodeGen] Print MCSymbol operands as <mcsymbol sym> in both MIR and
 debug output

Work towards the unification of MIR and debug output by printing
`<mcsymbol sym>` instead of `<MCSym=sym>`.

Only debug syntax is affected.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@320685 91177308-0d34-0410-b5e6-96231b3b80d8
---
 docs/MIRLangRef.rst | 13 +++++++++++++
 1 file changed, 13 insertions(+)

(limited to 'docs')

diff --git a/docs/MIRLangRef.rst b/docs/MIRLangRef.rst
index 14ac63bbd9d..f170c721087 100644
--- a/docs/MIRLangRef.rst
+++ b/docs/MIRLangRef.rst
@@ -121,6 +121,8 @@ Tests are more accessible and future proof when simplified:
   contains dummy functions (see above). The .mir loader will create the
   IR functions automatically in this case.
 
+.. _limitations:
+
 Limitations
 -----------
 
@@ -678,6 +680,17 @@ Example:
 
     CALL64pcrel32 $__stack_chk_fail, csr_64, implicit %rsp, implicit-def %rsp
 
+MCSymbol Operands
+^^^^^^^^^^^^^^^^^
+
+A MCSymbol operand is holding a pointer to a ``MCSymbol``. For the limitations
+of this operand in MIR, see :ref:`limitations <limitations>`.
+
+The syntax is:
+
+.. code-block:: text
+
+    EH_LABEL <mcsymbol Ltmp1>
 
 .. TODO: Describe the parsers default behaviour when optional YAML attributes
    are missing.
-- 
cgit v1.2.3