[MLIR][doc] Clarify `allowUnregisteredDialects()` as "testing option" (NFC)
authorMehdi Amini <joker.eph@gmail.com>
Sat, 25 Feb 2023 00:29:02 +0000 (17:29 -0700)
committerMehdi Amini <joker.eph@gmail.com>
Sat, 25 Feb 2023 00:34:25 +0000 (17:34 -0700)
Reviewed By: jpienaar

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

mlir/include/mlir/IR/MLIRContext.h

index 7537f0c..5750dfc 100644 (file)
@@ -132,6 +132,10 @@ public:
   bool allowsUnregisteredDialects();
 
   /// Enables creating operations in unregistered dialects.
+  /// This option is **heavily discouraged**: it is convenient during testing
+  /// but it is not a good practice to use it in production code. Some system
+  /// invariants can be broken (like loading a dialect after creating
+  ///  operations) without being caught by assertions or other means.
   void allowUnregisteredDialects(bool allow = true);
 
   /// Return true if multi-threading is enabled by the context.