Skip to content

Commit 3cd2985

Browse files
authored
[docs] Move extra cmake command options in development.md (#4081)
- Makes the "in-tree" and "out-of-tree" LLVM contexts adjacent to each other
1 parent 90350e6 commit 3cd2985

File tree

1 file changed

+17
-16
lines changed

1 file changed

+17
-16
lines changed

docs/development.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -150,22 +150,6 @@ cmake -GNinja -Bbuild \
150150
externals/llvm-project/llvm
151151
```
152152
153-
##### Options to enable MLIR debugging
154-
155-
* Enabling `--debug` and `--debug-only` flags (see [MLIR docs](https://mlir.llvm.org/getting_started/Debugging/)) for the `torch-mlir-opt` tool
156-
```shell
157-
-DCMAKE_BUILD_TYPE=RelWithDebInfo \ # or =Debug
158-
-DLLVM_ENABLE_ASSERTIONS=ON \
159-
```
160-
161-
##### Options to run end-to-end tests
162-
163-
Running the end-to-end execution tests locally requires enabling the native PyTorch extension features and the JIT IR importer, which depends on the
164-
former and defaults to `ON` if not changed:
165-
```shell
166-
-DTORCH_MLIR_ENABLE_PYTORCH_EXTENSIONS=ON \
167-
-DTORCH_MLIR_ENABLE_JIT_IR_IMPORTER=ON \
168-
```
169153
170154
##### ...with LLVM "out-of-tree"
171155
@@ -184,6 +168,23 @@ The same QoL CMake flags can be used to enable clang, ccache, and lld. Be sure t
184168
185169
Be aware that the installed version of LLVM needs in general to match the committed version in `externals/llvm-project`. Using a different version may or may not work.
186170
171+
##### Options to enable MLIR debugging
172+
173+
* Enabling `--debug` and `--debug-only` flags (see [MLIR docs](https://mlir.llvm.org/getting_started/Debugging/)) for the `torch-mlir-opt` tool
174+
```shell
175+
-DCMAKE_BUILD_TYPE=RelWithDebInfo \ # or =Debug
176+
-DLLVM_ENABLE_ASSERTIONS=ON \
177+
```
178+
179+
##### Options to run end-to-end tests
180+
181+
Running the end-to-end execution tests locally requires enabling the native PyTorch extension features and the JIT IR importer, which depends on the
182+
former and defaults to `ON` if not changed:
183+
```shell
184+
-DTORCH_MLIR_ENABLE_PYTORCH_EXTENSIONS=ON \
185+
-DTORCH_MLIR_ENABLE_JIT_IR_IMPORTER=ON \
186+
```
187+
187188
#### Initiate Build
188189
189190
After either cmake run (in-tree/out-of-tree), use one of the following commands to build the project:

0 commit comments

Comments
 (0)