From 83c72fd8772d312233f4e3ccd4154b81030d4795 Mon Sep 17 00:00:00 2001
From: Ellie Hermaszewska <ellieh@nvidia.com>
Date: Wed, 2 Jul 2025 09:20:29 +0800
Subject: Comment SLANG_OVERRIDE options (#7584)

Closes https://github.com/shader-slang/slang/issues/7309
---
 CMakeLists.txt | 6 ++++++
 1 file changed, 6 insertions(+)

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"
-- 
cgit v1.2.3