Skip to content

Commit 07ad3c1

Browse files
authored
[docs] Restructure the "Initiate Build" section in development.md (#4111)
- include prerequisite - number the steps - put "vanilla" command first - separate fenced code blocks to leverage GitHub's copy button
1 parent 5af71da commit 07ad3c1

File tree

1 file changed

+23
-11
lines changed

1 file changed

+23
-11
lines changed

docs/development.md

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -189,21 +189,33 @@ former and defaults to `ON` if not changed:
189189
190190
#### Initiate Build
191191
192-
After either cmake run (in-tree/out-of-tree), use one of the following commands to build the project:
192+
1. [Configure the build](#configure-for-building) if you haven't already done so.
193+
1. **If you want to...**
194+
- **...build _everything_** (including LLVM if configured as "in-tree"), run:
193195
194-
```shell
195-
# Build just torch-mlir (not all of LLVM)
196-
cmake --build build --target tools/torch-mlir/all
196+
```shell
197+
cmake --build build
198+
```
197199
198-
# Run unit tests.
199-
cmake --build build --target check-torch-mlir
200+
- **...build _just_ torch-mlir** (not all of LLVM), run:
200201
201-
# Run Python regression tests.
202-
cmake --build build --target check-torch-mlir-python
202+
```shell
203+
cmake --build build --target tools/torch-mlir/all
204+
```
203205
204-
# Build everything (including LLVM if in-tree)
205-
cmake --build build
206-
```
206+
- **...run unit tests**, run:
207+
208+
```shell
209+
cmake --build build --target check-torch-mlir
210+
```
211+
212+
- **...run Python regression tests**, run:
213+
214+
```shell
215+
cmake --build build --target check-torch-mlir-python
216+
```
217+
218+
TIP: add multiple target options to stack build phases
207219
208220
### Setup Python Environment to export the built Python packages
209221

0 commit comments

Comments
 (0)