Add a section in the DeveloperGuide for the naming convention of command line...
authorMehdi Amini <aminim@google.com>
Sat, 4 May 2019 01:43:22 +0000 (18:43 -0700)
committerMehdi Amini <joker.eph@gmail.com>
Mon, 6 May 2019 15:27:51 +0000 (08:27 -0700)
--

PiperOrigin-RevId: 246610123

mlir/g3doc/DeveloperGuide.md

index b92414a..03a4d3f 100644 (file)
@@ -10,3 +10,12 @@ MLIR follows the [LLVM style](https://llvm.org/docs/CodingStandards.html) guide
 except:
 
 *   Adopts [camelBack](https://llvm.org/docs/Proposals/VariableNames.html);
+
+## Pass name and other command line options
+
+To avoid collision between options provided by different dialects, the naming
+convention is to prepend the dialect name to every dialect-specific passes and
+options in general. Also options that are specific to a pass should also be
+prefixed with the pass name. For example, the affine dialect is providing a
+loop tiling pass that will be registered on the command line as "-affine-tile",
+and the tile size option can be set with "-affine-tile-size".