[Mlir-commits] [mlir] 11c0832 - [MLIR][LLVM] Improve module translation comment (NFC) (#94577)

[llvmlistbot at llvm.org]

Author: Christian Ulmann
Date: 2024-06-06T08:23:00+02:00
New Revision: 11c08327dab425b67d80e99850e654e4c6c17864

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

LOG: [MLIR][LLVM] Improve module translation comment (NFC) (#94577)

This commit enhances the docsting of `translateModuleToLLVMIR` as a
followup to https://github.com/llvm/llvm-project/pull/94445

Added: 
    

Modified: 
    mlir/include/mlir/Target/LLVMIR/Export.h

Removed: 
    


################################################################################
diff  --git a/mlir/include/mlir/Target/LLVMIR/Export.h b/mlir/include/mlir/Target/LLVMIR/Export.h
index 2244968655138..893aaaa4faff6 100644
--- a/mlir/include/mlir/Target/LLVMIR/Export.h
+++ b/mlir/include/mlir/Target/LLVMIR/Export.h
@@ -20,10 +20,11 @@ class Module;
 namespace mlir {
 class Operation;
 
-/// Translate operation that satisfies LLVM dialect module requirements into an
-/// LLVM IR module living in the given context. This translates operations from
-/// any dilalect that has a registered implementation of
-/// LLVMTranslationDialectInterface.
+/// Translates a given LLVM dialect `module` into an LLVM IR module living in
+/// the given context. Operates on any operation from dialects that provide a
+/// registered implementation of the LLVMTranslationDialectInterface. Returns
+/// nullptr when the translation fails.
+/// Verifies the produced LLVM module, except when `disableVerification` is set.
 std::unique_ptr<llvm::Module>
 translateModuleToLLVMIR(Operation *module, llvm::LLVMContext &llvmContext,
                         llvm::StringRef name = "LLVMDialectModule",