[mlir] Clarify docs around LLVM dialect-compatible types
authorAlex Zinenko <zinenko@google.com>
Tue, 19 Jan 2021 12:42:16 +0000 (13:42 +0100)
committerAlex Zinenko <zinenko@google.com>
Tue, 19 Jan 2021 12:42:16 +0000 (13:42 +0100)
Explicitly mention that there is exactly one MLIR type that corresponds
to a given LLVM IR type.

mlir/docs/Dialects/LLVM.md

index b396cde..521c5f4 100644 (file)
@@ -224,6 +224,11 @@ compatible. For example, signed and unsigned integers are not compatible. LLVM
 provides a function, `bool LLVM::isCompatibleType(Type)`, that can be used as a
 compatibility check.
 
+Each LLVM IR type corresponds to *exactly one* MLIR type, either built-in or
+LLVM dialect type. For example, because `i32` is LLVM-compatible, there is no
+`!llvm.i32` type. However, `!llvm.ptr<T>` is defined in the LLVM dialect as
+there is no corresponding built-in type.
+
 ### Additional Simple Types
 
 The following non-parametric types derived from the LLVM IR are available in the