[Assignment Tracking][Docs] Add new metadata to LangRef.rst
authorOCHyams <orlando.hyams@sony.com>
Wed, 11 Jan 2023 15:38:01 +0000 (15:38 +0000)
committerOCHyams <orlando.hyams@sony.com>
Wed, 11 Jan 2023 15:48:36 +0000 (15:48 +0000)
And link to the AssignmentTracking.md document which goes into more detail.

Reviewed By: jryans

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

llvm/docs/LangRef.rst

index 2cfceb0b2efb2045b853594f562bf7d2316f06bf..0e2c08d24c758fe8e4d221f31247cbb811f7b83f 100644 (file)
@@ -5998,6 +5998,21 @@ valid debug intrinsic.
     !4 = !DIExpression(DW_OP_constu, 2, DW_OP_swap, DW_OP_xderef)
     !5 = !DIExpression(DW_OP_constu, 42, DW_OP_stack_value)
 
+DIAssignID
+""""""""""""
+
+``DIAssignID`` nodes have no operands and are always distinct. They are used to
+link together `@llvm.dbg.assign` intrinsics (:ref:`debug
+intrinsics<dbg_intrinsics>`) and instructions that store in IR. See `Debug Info
+Assignment Tracking <AssignmentTracking.html>`_ for more info.
+
+.. code-block:: llvm
+
+    store i32 %a, ptr %a.addr, align 4, !DIAssignID !2
+    llvm.dbg.assign(metadata %a, metadata !1, metadata !DIExpression(), !2, metadata %a.addr, metadata !DIExpression()), !dbg !3
+
+    !2 = distinct !DIAssignID()
+
 DIArgList
 """"""""""""