Skip to content

Commit fbbd474

Browse files
authored
[docs] Emphasize mutual exclusivity of "in-tree" vs "out-of-tree" (#4160)
1 parent a1769ad commit fbbd474

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

docs/development.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -93,11 +93,13 @@ sudo apt install clang ccache lld
9393
1. Set up Developer PowerShell [for Visual Studio](https://learn.microsoft.com/en-us/visualstudio/ide/reference/command-prompt-powershell?view=vs-2022#start-in-visual-studio)
9494
1. Ensure that the compiler and linker binaries are in the `PATH` variable.
9595

96-
#### Configure for Building...
96+
#### Configure for Building
9797

98-
Two setups are possible to build: in-tree and out-of-tree. The in-tree setup is the most straightforward, as it will build LLVM dependencies as well.
98+
##### Choose command relevant to LLVM setup:
9999

100-
##### ...with LLVM "in-tree"
100+
###### If you want the more straightforward option
101+
102+
Run the "in-tree" setup:
101103

102104
```shell
103105
cmake -GNinja -Bbuild \
@@ -116,9 +118,9 @@ cmake -GNinja -Bbuild \
116118

117119
- NOTE: uses external/llvm-project/llvm as the main build, so LLVM will be built in addition to torch-mlir and its sub-projects.
118120

119-
##### ...with LLVM "out-of-tree"
121+
###### If you want to use a separate build of LLVM from another directory
120122

121-
If you have built llvm-project separately in the directory `$LLVM_INSTALL_DIR`, you can also build the project *out-of-tree* using the following command as template:
123+
Run the "out-of-tree" setup:
122124

123125
```shell
124126
cmake -GNinja -Bbuild \

0 commit comments

Comments
 (0)