Document that non-IR units are passed by non-const reference instead of pointer in general

PiperOrigin-RevId: 266583029
This commit is contained in:
Mehdi Amini 2019-08-31 15:17:42 -07:00 committed by A. Unique TensorFlower
parent 49c3e4a508
commit d4d32f4cb8
1 changed files with 5 additions and 2 deletions

View File

@ -6,10 +6,13 @@ methods).
## Style guide
MLIR follows the [LLVM style](https://llvm.org/docs/CodingStandards.html) guide
except:
MLIR follows the [LLVM style](https://llvm.org/docs/CodingStandards.html) guide.
We also adhere to the following, that deviates from, or isn't specified in the
LLVM style guide:
* Adopts [camelBack](https://llvm.org/docs/Proposals/VariableNames.html);
* Except for IR units (Region, Block, and Operation), non-nullable output
argument are passed by non-const reference in general.
## Pass name and other command line options