summaryrefslogtreecommitdiffstats
path: root/docs/doc-system.md
diff options
context:
space:
mode:
authorJay Kwak <82421531+jkwak-work@users.noreply.github.com>2024-10-25 10:14:22 -0700
committerGitHub <noreply@github.com>2024-10-25 10:14:22 -0700
commit4bad669bbc5ec3ff77321f083c59cde87eb10229 (patch)
treebf0abc916692cf34e804469bba400f2b04172472 /docs/doc-system.md
parentef40d3044cf75ec3d7b24a43257fa744b45274f9 (diff)
Replace stdlib on Slang API with CoreModule (#5405)
This is a breaking change in a way that the Slang API function names are changed. All of them are commented as "experimental" and we wouldn't provide a back-ward compatibility for them. Following functions are renamed: compileStdLib() -> compileCoreModule() loadStdLib() -> loadCoreModule() saveStdLib() -> saveCoreModule() slang_createGlobalSessionWithoutStdLib() -> slang_createGlobalSessionWithoutCoreModule() slang_getEmbeddedStdLib() -> slang_getEmbeddedCoreModule() hasDeferredStdLib() -> hasDeferredCoreModule() Following command-line arguments are renamed: "-load-stdlib" -> "-load-core-module" "-save-stdlib" -> "-save-core-module" "-save-stdlib-bin-source" -> "-save-core-module-bin-source" "-compile-stdlib" -> "-compile-core-module"
Diffstat (limited to 'docs/doc-system.md')
-rw-r--r--docs/doc-system.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/doc-system.md b/docs/doc-system.md
index 56635e4ed..1eb55f817 100644
--- a/docs/doc-system.md
+++ b/docs/doc-system.md
@@ -88,7 +88,7 @@ Currently the only documentation style supported is a single file 'markdown' out
It is possible to generate documentation for Slangs internal `stdlib`. This can be achieved with `slangc` via
```
-slangc -doc -compile-stdlib
+slangc -doc -compile-core-module
```
The documentation will be written to a file `stdlib-doc.md`.