Skip to content

[docs] Emphasize mutual exclusivity of "in-tree" vs "out-of-tree" #4160

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 30, 2025
Merged

[docs] Emphasize mutual exclusivity of "in-tree" vs "out-of-tree" #4160

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0cfa01d
docs(development.md): communicates mutual exclusivity of "in-tree" vs…
bjacobgordon Dec 19, 2024
cdc6b01
docs(development.md): recovers deleted context
bjacobgordon Apr 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions docs/development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,11 +93,13 @@ sudo apt install clang ccache lld
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)
1. Ensure that the compiler and linker binaries are in the `PATH` variable.

#### Configure for Building...
#### Configure for Building

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.
##### Choose command relevant to LLVM setup:

##### ...with LLVM "in-tree"
###### If you want the more straightforward option

Run the "in-tree" setup:

```shell
cmake -GNinja -Bbuild \
Expand All @@ -116,9 +118,9 @@ cmake -GNinja -Bbuild \

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

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

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:
Run the "out-of-tree" setup:

```shell
cmake -GNinja -Bbuild \
Expand Down
Loading