Index: llvm/docs/MIRLangRef.rst =================================================================== --- llvm/docs/MIRLangRef.rst +++ llvm/docs/MIRLangRef.rst @@ -506,6 +506,24 @@ .. TODO: Describe the FPIMM immediate operands. +Comments +^^^^^^^^ + +Machine operands can have C/C++ style comments, which are annotations enclosed +between ``/*`` and ``*/`` to improve readability of e.g. immediate operands. +In the example below, ARM instructions EOR and BCC and immediate operands +``14`` and ``0`` have been annotated with their condition codes (CC) +definitions, i.e. the ``always`` and ``eq`` condition codes: + +.. code-block:: text + + dead renamable $r2, $cpsr = tEOR killed renamable $r2, renamable $r1, 14 /* CC::always */, $noreg + t2Bcc %bb.4, 0 /* CC:eq */, killed $cpsr + +As these annotations are comments, they are ignored by the MI parser. +Comments can be added or customized by overriding InstrInfo's hook +``createMIROperandComment()``. + .. _register-operands: Register Operands