summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEllie Hermaszewska <ellieh@nvidia.com>2024-08-17 01:20:00 +0800
committerGitHub <noreply@github.com>2024-08-16 10:20:00 -0700
commitf447b74991e37bba6c8d1f69983fc308dd94e90b (patch)
treecb22cb933ad492ca048e4ea7accfffb7f64c82ba
parent0c468a3e7e693b12a59f643be4c7fea5ee29e5e3 (diff)
Update documentation for #include to indicate it is for legacy code and new code should use modules (#4862)
Closes https://github.com/shader-slang/slang/issues/4281
-rw-r--r--docs/user-guide/02-conventional-features.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/user-guide/02-conventional-features.md b/docs/user-guide/02-conventional-features.md
index bd8f0435c..ff29d7c83 100644
--- a/docs/user-guide/02-conventional-features.md
+++ b/docs/user-guide/02-conventional-features.md
@@ -492,6 +492,11 @@ Slang supports a C-style preprocessor with the following directives;
Variadic macros are supported by the Slang preprocessor.
+> #### Note ####
+> The use of `#include` in new code is discouraged as this functionality has
+> been superseded by the module system, please refer to
+> [./04-modules-and-access-control.md](./04-modules-and-access-control.md)
+
Attributes
----------