diff options
| author | Jay Kwak <82421531+jkwak-work@users.noreply.github.com> | 2024-10-25 10:14:22 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-10-25 10:14:22 -0700 |
| commit | 4bad669bbc5ec3ff77321f083c59cde87eb10229 (patch) | |
| tree | bf0abc916692cf34e804469bba400f2b04172472 /docs/stdlib-docgen.md | |
| parent | ef40d3044cf75ec3d7b24a43257fa744b45274f9 (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/stdlib-docgen.md')
| -rw-r--r-- | docs/stdlib-docgen.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/stdlib-docgen.md b/docs/stdlib-docgen.md index df9317de9..0be3af548 100644 --- a/docs/stdlib-docgen.md +++ b/docs/stdlib-docgen.md @@ -19,7 +19,7 @@ rm -rf ./global-decls rm -rf ./attributes # generate updated pages -slangc -compile-stdlib -doc +slangc -compile-core-module -doc # optional: move generated toc.html to `_includes` mv toc.html ./_includes/stdlib-reference-toc.html @@ -96,7 +96,7 @@ as with `@remarks`. - Include examples if needed in the examples section. - Provide a see also section with links to related declarations. -After updating comments, build `slangc`, and run `slangc -compile-stdlib -doc` in `stdlib-reference` diretory to update the markdown files for preview. +After updating comments, build `slangc`, and run `slangc -compile-core-module -doc` in `stdlib-reference` diretory to update the markdown files for preview. Your PR only needs to include changes to *.meta.slang files. Once your PR is merged, slang CI will run `slangc` and push the updated markdown files to the `stdlib-reference` repo. @@ -111,4 +111,4 @@ C++'s visiblity modifiers: they apply to everything after it. To preview github pages locally, you need to follow instructions on setting up Jekyll: https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll -You will need to use Jekyll to create a Gem file before serving it.
\ No newline at end of file +You will need to use Jekyll to create a Gem file before serving it. |