Skip to content

Commit

Permalink
docs(development.md): restructures the "Initiate Build" section
Browse files Browse the repository at this point in the history
- less repetitive
- emphasizes that the targets can be superimposed
  • Loading branch information
bjacobgordon committed Jan 2, 2025
1 parent 9623ce1 commit 0927acd
Showing 1 changed file with 14 additions and 11 deletions.
25 changes: 14 additions & 11 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,31 +183,34 @@ For workflows that demand frequent rebuilds, the following steps will allow you
### Initiate Build
1. [Configure the build](#configure-for-building) if you haven't already done so.
1. Use one of the following commands to build the project:
- Build everything (including LLVM if in-tree)
1. Append the base command:
```shell
cmake --build build
```
```shell
cmake --build build
```
- Build just torch-mlir (not all of LLVM)
1. **If you want to...**
- **...build _just_ torch-mlir (not all of LLVM)**, append:
```shell
cmake --build build --target tools/torch-mlir/all
--target tools/torch-mlir/all
```
- Run unit tests.
- NOTE: skipping this will result in _everything_ being built, which includes LLVM if configured as "in-tree"
- **...run unit tests**, append:
```shell
cmake --build build --target check-torch-mlir
--target check-torch-mlir
```
- Run Python regression tests.
- **...run Python regression tests**, append:
```shell
cmake --build build --target check-torch-mlir-python
--target check-torch-mlir-python
```
1. Execute the command with the desired targets, if any.
## Setup Python Environment to export the built Python packages
### Linux and macOS
Expand Down

0 comments on commit 0927acd

Please sign in to comment.