summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorEllie Hermaszewska <ellieh@nvidia.com>2024-08-21 15:59:08 +0800
committerGitHub <noreply@github.com>2024-08-21 15:59:08 +0800
commitf503a0b3faf5d324c62881d61e1ba1e0942becd9 (patch)
treefeb6619052e7e1148561adb2b79776f35cf6f4c4 /docs
parent19db4e9c03be017cbf8b13034d86e9e49224b4cf (diff)
Dont require llvm for building generators (#4895)
* Dont require llvm for building generators * Fetch slang-llvm.so from correct release (#4847) * Fetch slang-llvm.so from correct release Closes https://github.com/shader-slang/slang/issues/4648 Should close https://github.com/shader-slang/slang/issues/4812 * Update docs * Correct documentation on cmake option * Neaten cmake script * Fix fetching on windows --------- Co-authored-by: Yong He <yonghe@outlook.com> * Be a bit more careful dealing with release list fetching failure * clarify error messages --------- Co-authored-by: Yong He <yonghe@outlook.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/building.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/building.md b/docs/building.md
index 2b2435302..d86b80205 100644
--- a/docs/building.md
+++ b/docs/building.md
@@ -101,6 +101,10 @@ There are several options for getting llvm-support:
- You can set `SLANG_SLANG_LLVM_BINARY_URL` to point to a local
`libslang-llvm.so/slang-llvm.dll` or set it to a URL of an zip/archive
containing such a file
+ - If this isn't set then the build system tries to download it from the
+ release on github matching the current tag. If such a tag doesn't exist
+ or doesn't have the correct os*arch combination then the latest release
+ will be tried.
- Use a system supplied LLVM: `-DSLANG_SLANG_LLVM_FLAVOR=USE_SYSTEM_LLVM`, you
must have llvm-13.0 and a matching libclang installed. It's important that
either: