[MLIR] Discourage people from copying the toy examples

stephenneuendorffer · stephenneuendorffer · commit d02fce2d149e · 2020-05-13T10:37:06.000-07:00
The CMake structure of the toy example is non-standard. encourage people to copy the standalone example instead. Differential Revision: https://reviews.llvm.org/D79889
diff --git a/mlir/examples/toy/Ch1/CMakeLists.txt b/mlir/examples/toy/Ch1/CMakeLists.txt
@@ -1,3 +1,4 @@
+# For a better template to copy, see examples/standalone
 set(LLVM_LINK_COMPONENTS
   Support
   )
diff --git a/mlir/examples/toy/Ch2/CMakeLists.txt b/mlir/examples/toy/Ch2/CMakeLists.txt
@@ -1,3 +1,4 @@
+# For a better template to copy, see examples/standalone
 add_subdirectory(include)
 
 set(LLVM_LINK_COMPONENTS
diff --git a/mlir/examples/toy/Ch3/CMakeLists.txt b/mlir/examples/toy/Ch3/CMakeLists.txt
@@ -1,3 +1,4 @@
+# For a better template to copy, see examples/standalone
 include_directories(include)
 add_subdirectory(include)
 
diff --git a/mlir/examples/toy/Ch4/CMakeLists.txt b/mlir/examples/toy/Ch4/CMakeLists.txt
@@ -1,3 +1,4 @@
+# For a better template to copy, see examples/standalone
 include_directories(include)
 add_subdirectory(include)
 
diff --git a/mlir/examples/toy/Ch4/include/toy/CMakeLists.txt b/mlir/examples/toy/Ch4/include/toy/CMakeLists.txt
@@ -1,8 +1,10 @@
+# Most dialects should use add_mlir_dialect().  See examples/standalone.
 set(LLVM_TARGET_DEFINITIONS Ops.td)
 mlir_tablegen(Ops.h.inc -gen-op-decls)
 mlir_tablegen(Ops.cpp.inc -gen-op-defs)
 add_public_tablegen_target(ToyCh4OpsIncGen)
 
+# Most dialects should use add_mlir_interfaces().
 set(LLVM_TARGET_DEFINITIONS ShapeInferenceInterface.td)
 mlir_tablegen(ShapeInferenceOpInterfaces.h.inc -gen-op-interface-decls)
 mlir_tablegen(ShapeInferenceOpInterfaces.cpp.inc -gen-op-interface-defs)
diff --git a/mlir/examples/toy/Ch5/CMakeLists.txt b/mlir/examples/toy/Ch5/CMakeLists.txt
@@ -1,3 +1,4 @@
+# For a better template to copy, see examples/standalone
 include_directories(include)
 add_subdirectory(include)
 
diff --git a/mlir/examples/toy/Ch5/include/toy/CMakeLists.txt b/mlir/examples/toy/Ch5/include/toy/CMakeLists.txt
@@ -1,8 +1,10 @@
+# Most dialects should use add_mlir_dialect().  See examples/standalone.
 set(LLVM_TARGET_DEFINITIONS Ops.td)
 mlir_tablegen(Ops.h.inc -gen-op-decls)
 mlir_tablegen(Ops.cpp.inc -gen-op-defs)
 add_public_tablegen_target(ToyCh5OpsIncGen)
 
+# Most dialects should use add_mlir_interfaces().
 set(LLVM_TARGET_DEFINITIONS ShapeInferenceInterface.td)
 mlir_tablegen(ShapeInferenceOpInterfaces.h.inc -gen-op-interface-decls)
 mlir_tablegen(ShapeInferenceOpInterfaces.cpp.inc -gen-op-interface-defs)
diff --git a/mlir/examples/toy/Ch6/CMakeLists.txt b/mlir/examples/toy/Ch6/CMakeLists.txt
@@ -1,3 +1,4 @@
+# For a better template to copy, see examples/standalone
 include_directories(include)
 add_subdirectory(include)
 
diff --git a/mlir/examples/toy/Ch6/include/toy/CMakeLists.txt b/mlir/examples/toy/Ch6/include/toy/CMakeLists.txt
@@ -1,8 +1,10 @@
+# Most dialects should use add_mlir_dialect().  See examples/standalone.
 set(LLVM_TARGET_DEFINITIONS Ops.td)
 mlir_tablegen(Ops.h.inc -gen-op-decls)
 mlir_tablegen(Ops.cpp.inc -gen-op-defs)
 add_public_tablegen_target(ToyCh6OpsIncGen)
 
+# Most dialects should use add_mlir_interfaces().
 set(LLVM_TARGET_DEFINITIONS ShapeInferenceInterface.td)
 mlir_tablegen(ShapeInferenceOpInterfaces.h.inc -gen-op-interface-decls)
 mlir_tablegen(ShapeInferenceOpInterfaces.cpp.inc -gen-op-interface-defs)
diff --git a/mlir/examples/toy/Ch7/CMakeLists.txt b/mlir/examples/toy/Ch7/CMakeLists.txt
@@ -1,3 +1,4 @@
+# For a better template to copy, see examples/standalone
 include_directories(include)
 add_subdirectory(include)
 
diff --git a/mlir/examples/toy/Ch7/include/toy/CMakeLists.txt b/mlir/examples/toy/Ch7/include/toy/CMakeLists.txt
@@ -1,8 +1,10 @@
+# Most dialects should use add_mlir_dialect().  See examples/standalone.
 set(LLVM_TARGET_DEFINITIONS Ops.td)
 mlir_tablegen(Ops.h.inc -gen-op-decls)
 mlir_tablegen(Ops.cpp.inc -gen-op-defs)
 add_public_tablegen_target(ToyCh7OpsIncGen)
 
+# Most dialects should use add_mlir_interfaces().
 set(LLVM_TARGET_DEFINITIONS ShapeInferenceInterface.td)
 mlir_tablegen(ShapeInferenceOpInterfaces.h.inc -gen-op-interface-decls)
 mlir_tablegen(ShapeInferenceOpInterfaces.cpp.inc -gen-op-interface-defs)

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+# For a better template to copy, see examples/standalone`
`1`	`2`	`set(LLVM_LINK_COMPONENTS`
`2`	`3`	`Support`
`3`	`4`	`)`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+# For a better template to copy, see examples/standalone`
`1`	`2`	`add_subdirectory(include)`
`2`	`3`
`3`	`4`	`set(LLVM_LINK_COMPONENTS`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+# For a better template to copy, see examples/standalone`
`1`	`2`	`include_directories(include)`
`2`	`3`	`add_subdirectory(include)`
`3`	`4`