summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAnders Leino <aleino@nvidia.com>2025-02-27 20:29:00 +0200
committerGitHub <noreply@github.com>2025-02-27 10:29:00 -0800
commit2ebf9555a54c00f45b1cd0bdd7f6c163120bb845 (patch)
tree8ac5208ff86fb4792c88c6a7dbe4609327a666f7
parent1fb3c1536587d6ed085f13af78101cbfb3481dca (diff)
Document bug with global session teardown in user guide (#6479)
This closes #6344. Co-authored-by: Yong He <yonghe@outlook.com>
-rw-r--r--docs/user-guide/08-compiling.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/user-guide/08-compiling.md b/docs/user-guide/08-compiling.md
index c600b8cbb..1a730e26b 100644
--- a/docs/user-guide/08-compiling.md
+++ b/docs/user-guide/08-compiling.md
@@ -603,6 +603,10 @@ for compiling GLSL code. Without this setting, compiling GLSL code will result i
> Currently, the global session type is *not* thread-safe.
> Applications that wish to compile on multiple threads will need to ensure that each concurrent thread compiles with a distinct global session.
+> #### Note ####
+> Currently, the global session should be freed after any objects created from it.
+> See [issue 6344](https://github.com/shader-slang/slang/issues/6344).
+
### Creating a Session
A _session_ uses the interface `slang::ISession`, and represents a scope for compilation with a consistent set of compiler options.