Skip to content
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

Adds CMake presets documentation #27

Open
wants to merge 2 commits into
base: www
Choose a base branch
from
Open

Adds CMake presets documentation #27

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
06270ab
Adds CMake preset build documentation
MattBolitho Nov 17, 2024
a89d689
Clarifies preset listing commands
MattBolitho Nov 17, 2024
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
9 changes: 9 additions & 0 deletions content/Installation/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,16 @@ ninja

This should create a file `Enzyme/LLVMEnzyme-<VERSION>.so` inside the build directory, which contains the LLVM analysis and optimization passes that implement Enzyme.

Alternatively, [CMake Presets](https://cmake.org/cmake/help/latest/manual/cmake-presets.7.html) can be used to execute or extend a pre-configured build.
We can see a list of all available configure presets by running `cmake --list-presets` in the directory of the root CMake project.
Run `cmake --build --list-presets` for a list of build presets.

To build Enzyme using CMake presets, pass the names of the desired configure and build presets to the `cmake` invocation.

```sh
cmake --preset x64-linux-clang-release -DLLVM_DIR=/path/to/llvm/lib/cmake/llvm
cmake --build --preset x64-linux-clang-release
```

## Verifying installation

Expand Down