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

Update documentation to clarify LLVM version requirements #705

Merged
merged 4 commits into from
Sep 29, 2023
Merged

Update documentation to clarify LLVM version requirements #705

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
116ff40
Update Building.md to clarify LLVM version requirements
bmhowe23 Sep 27, 2023
7abc77e
Spelling: get rid of the word workstream
bmhowe23 Sep 27, 2023
94805aa
Merge branch 'main' into ch-llvm-docs-update
bettinaheim Sep 28, 2023
c17562a
Merge branch 'main' into ch-llvm-docs-update
bmhowe23 Sep 29, 2023
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
15 changes: 11 additions & 4 deletions Building.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,17 @@ correct path to your cuQuantum installation by setting the environment variable

## Building CUDA Quantum with a custom LLVM version

CUDA Quantum is intended to be built using the LLVM commit that the submodule is
set to. If you need to update the LLVM commit, or if you are not using the
pre-built version of that commit in our development container, LLVM will need to
be built from source. To configure our build scripts, please set the LLVM
CUDA Quantum is intended to be built using the LLVM commit that the submodule
is set to (currently LLVM 16.0.6). If you need to update the LLVM commit, or if
you are not using the pre-built version of that commit in our development
container, LLVM will need to be built from source. ***Building with LLVM >=
17.x is not currently supported*** due to the QIR specification's requirement
bmhowe23 marked this conversation as resolved.
Show resolved Hide resolved
to use typed pointers. LLVM 17.x removed the ability to use typed pointers and
instead now requires [opaque pointers](https://llvm.org/docs/OpaquePointers.html#version-support).
The QIR specification will be updated to support opaque pointers in the near
future.

To configure our build scripts with a custom LLVM, please set the LLVM
submodule to the desired commit, and set the following environment variable,
replacing `<installation_path>` with the path where the freshly built LLVM tools
and libraries should be installed:
Expand Down
Loading