[flang-commits] [flang] [flang][NFC] Add missing sourceBox documentation in embox ops (PR #101221)

[via flang-commits]

llvmbot wrote:


<!--LLVM PR SUMMARY COMMENT-->

@llvm/pr-subscribers-flang-fir-hlfir

Author: Valentin Clement (バレンタイン クレメン) (clementval)

<details>
<summary>Changes</summary>

Just noticed that `sourceDoc` was not documented in embox operations description. this patch just add the documentation. 

---
Full diff: https://github.com/llvm/llvm-project/pull/101221.diff


2 Files Affected:

- (modified) flang/include/flang/Optimizer/CodeGen/CGOps.td (+2) 
- (modified) flang/include/flang/Optimizer/Dialect/FIROps.td (+2) 


``````````diff
diff --git a/flang/include/flang/Optimizer/CodeGen/CGOps.td b/flang/include/flang/Optimizer/CodeGen/CGOps.td
index f4740a263ffd2..2e07994690e5f 100644
--- a/flang/include/flang/Optimizer/CodeGen/CGOps.td
+++ b/flang/include/flang/Optimizer/CodeGen/CGOps.td
@@ -48,6 +48,8 @@ def fircg_XEmboxOp : fircg_Op<"ext_embox", [AttrSizedOperandSegments]> {
        - substring: A substring operator (offset, length) for CHARACTER.
        - LEN type parameters: A vector of runtime LEN type parameters that
          describe an correspond to the elemental derived type.
+       - sourceBox: A box to read information from such as CFI type,
+         type descriptor or element size to populate the new descriptor.
 
     The memref and shape arguments are mandatory. The rest are optional.
   }];
diff --git a/flang/include/flang/Optimizer/Dialect/FIROps.td b/flang/include/flang/Optimizer/Dialect/FIROps.td
index bee8e8f603ce3..2b09745b49cfd 100644
--- a/flang/include/flang/Optimizer/Dialect/FIROps.td
+++ b/flang/include/flang/Optimizer/Dialect/FIROps.td
@@ -782,6 +782,8 @@ def fir_EmboxOp : fir_Op<"embox", [NoMemoryEffect, AttrSizedOperandSegments]> {
           lower bounds and extents may not be known until runtime),
         - slice: an array section can be described with a slice triple,
         - typeparams: for emboxing a derived type with LEN type parameters,
+        - sourceBox: A box to read information from such as CFI type,
+          type descriptor or element size to populate the new descriptor.
         - accessMap: unused/experimental.
   }];
 

``````````

</details>


https://github.com/llvm/llvm-project/pull/101221