summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEllie Hermaszewska <ellieh@nvidia.com>2025-07-02 09:20:29 +0800
committerGitHub <noreply@github.com>2025-07-02 01:20:29 +0000
commit83c72fd8772d312233f4e3ccd4154b81030d4795 (patch)
tree657a92ad6d52672a97c6a01ef5489212663b1329
parenteb7f3357a1c316bad51cf0bfaea27d81a93f96ad (diff)
Comment SLANG_OVERRIDE options (#7584)
Closes https://github.com/shader-slang/slang/issues/7309
-rw-r--r--CMakeLists.txt6
1 files changed, 6 insertions, 0 deletions
diff --git a/CMakeLists.txt b/CMakeLists.txt
index eb1c5808f..549e465ac 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -183,6 +183,12 @@ option(
mark_as_advanced(SLANG_SPIRV_HEADERS_INCLUDE_DIR)
# Options for user defined paths for external modules.
+#
+# Note that these paths point to a directory containing an subdirectory of the
+# dependency name, rather than to the dependency directory itself, for example
+# SLANG_OVERRIDE_LZ4_PATH points to a directory containing a directory called
+# `lz4` containing the lz4 source.
+#
advanced_option(
SLANG_OVERRIDE_LZ4_PATH
"Build using user defined path for LZ4"