[Mlir-commits] [mlir] 338cbfe - [mlir][Transforms][NFC] Improve dialect conversion documentation (#94736)

[llvmlistbot at llvm.org]

Author: Matthias Springer
Date: 2024-06-09T09:42:24+02:00
New Revision: 338cbfef03e0ab58d7b52f3301928c58b194a1b4

URL: https://github.com/llvm/llvm-project/commit/338cbfef03e0ab58d7b52f3301928c58b194a1b4
DIFF: https://github.com/llvm/llvm-project/commit/338cbfef03e0ab58d7b52f3301928c58b194a1b4.diff

LOG: [mlir][Transforms][NFC] Improve dialect conversion documentation (#94736)

Added: 
    

Modified: 
    mlir/include/mlir/Transforms/DialectConversion.h

Removed: 
    


################################################################################
diff  --git a/mlir/include/mlir/Transforms/DialectConversion.h b/mlir/include/mlir/Transforms/DialectConversion.h
index 83198c9b0db54..f6c51499f271c 100644
--- a/mlir/include/mlir/Transforms/DialectConversion.h
+++ b/mlir/include/mlir/Transforms/DialectConversion.h
@@ -1088,8 +1088,9 @@ struct ConversionConfig {
 
   /// An optional listener that is notified about all IR modifications in case
   /// dialect conversion succeeds. If the dialect conversion fails and no IR
-  /// modifications are visible (i.e., they were all rolled back), no
-  /// notifications are sent.
+  /// modifications are visible (i.e., they were all rolled back), or if the
+  /// dialect conversion is an "analysis conversion", no notifications are
+  /// sent (apart from `notifyPatternBegin`/notifyPatternEnd`).
   ///
   /// Note: Notifications are sent in a delayed fashion, when the dialect
   /// conversion is guaranteed to succeed. At that point, some IR modifications