diff options
| author | aidanfnv <aidanf@nvidia.com> | 2025-07-08 13:41:56 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-07-08 20:41:56 +0000 |
| commit | 0ab515159e9da15e0077d55c761ca0f326361257 (patch) | |
| tree | 845185acb6a753c1ec99ba6970c1d23936399fcc /docs | |
| parent | e52885347076f3dfbf96cb5b898fabf9b4c9562d (diff) | |
Add <help-category> list and hint on usage in slangc -h (#7638)
* Add category list at end of slangc -h output
* Use value category for categories
* format code (#12)
Co-authored-by: slangbot <186143334+slangbot@users.noreply.github.com>
* Regenerate cmdline reference
---------
Co-authored-by: slangbot <ellieh+slangbot@nvidia.com>
Co-authored-by: slangbot <186143334+slangbot@users.noreply.github.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/command-line-slangc-reference.md | 36 |
1 files changed, 35 insertions, 1 deletions
diff --git a/docs/command-line-slangc-reference.md b/docs/command-line-slangc-reference.md index c1ea9d720..d8d58ec9b 100644 --- a/docs/command-line-slangc-reference.md +++ b/docs/command-line-slangc-reference.md @@ -38,6 +38,7 @@ slangc -help-style markdown -h * [vulkan-shift](#vulkan-shift) * [capability](#capability) * [file-extension](#file-extension) +* [help-category](#help-category) <a id="General"></a> ## General @@ -94,7 +95,7 @@ Emit IR typically as a '.slang-module' when outputting to a container. <a id="h"></a> ### -h, -help, --help -**-h or -h <help-category>** +**-h or -h <[help-category](#help-category)>** Print this message, or help in specified category. @@ -1602,3 +1603,36 @@ A [<language>](#language), <format>, and/or [<stage>](#stage) * `slang-module`, `slang-library` : Slang Module/Library * `dir` : Container as a directory +<a id="help-category"></a> +## help-category + +Available help categories for the [-h](#h) option + +* `General` : General options +* `Target` : Target code generation options +* `Downstream` : Downstream compiler options +* `Debugging` : Compiler debugging/instrumentation options +* `Repro` : Slang repro system related +* `Experimental` : Experimental options (use at your own risk) +* `Internal` : Internal-use options (use at your own risk) +* `Deprecated` : Deprecated options (allowed but ignored; may be removed in future) +* `compiler` : Downstream Compilers (aka Pass through) +* `language` : Language +* `language-version` : Language Version +* `archive-type` : Archive Type +* `line-directive-mode` : Line Directive Mode +* `debug-info-format` : Debug Info Format +* `fp-mode` : Floating Point Mode +* `fp-denormal-mode` : Floating Point Denormal Handling Mode +* `help-style` : Help Style +* `optimization-level` : Optimization Level +* `debug-level` : Debug Level +* `file-system-type` : File System Type +* `source-embed-style` : Source Embed Style +* `target` : Target +* `stage` : Stage +* `vulkan-shift` : Vulkan Shift +* `capability` : A capability describes an optional feature that a target may or may not support. When a [-capability](#capability-1) is specified, the compiler may assume that the target supports that capability, and generate code accordingly. +* `file-extension` : A [<language>](#language), <format>, and/or [<stage>](#stage) may be inferred from the extension of an input or [-o](#o) path +* `help-category` : Available help categories for the [-h](#h) option + |