Skip to content

Add <help-category> list and hint on usage in slangc -h#7638

Merged
aidanfnv merged 4 commits intoshader-slang:masterfrom
aidanfnv:fix/slangc-help
Jul 8, 2025
Merged

Add <help-category> list and hint on usage in slangc -h#7638
aidanfnv merged 4 commits intoshader-slang:masterfrom
aidanfnv:fix/slangc-help

Conversation

@aidanfnv
Copy link
Copy Markdown
Contributor

@aidanfnv aidanfnv commented Jul 7, 2025

For #7088

The output of slangc --help is very long, and although it is split into subsections based on categories, it is not immediately obvious from the wall of text that the -h option can take a category as a value to only display that category. You have to look in the "General" category near the top of the help output to find that -h can take an optional value <help-category>. Furthermore, these categories are not listed in the output.

This change adds a new value category for <help-category> values as the last help category, listing all of the preceding categories (and itself), with this message at the end of the text output advising users that they can narrow down the output of slangc -h.

Getting Help for Specific Categories
=====================================

To get help for a specific category of options or values, use: slangc -h <help-category>
See the <help-category> section above for the list of categories.

@aidanfnv aidanfnv requested a review from a team as a code owner July 7, 2025 20:04
@aidanfnv aidanfnv added the pr: non-breaking PRs without breaking changes label Jul 7, 2025
@aidanfnv
Copy link
Copy Markdown
Contributor Author

aidanfnv commented Jul 7, 2025

/format

@slangbot
Copy link
Copy Markdown
Contributor

slangbot commented Jul 7, 2025

🌈 Formatted, please merge the changes from this PR

slangbot and others added 2 commits July 7, 2025 13:07
Co-authored-by: slangbot <186143334+slangbot@users.noreply.github.com>
@aidanfnv aidanfnv requested review from jkwak-work and swoods-nv July 7, 2025 21:24
@aidanfnv aidanfnv added this pull request to the merge queue Jul 8, 2025
@aidanfnv aidanfnv removed this pull request from the merge queue due to a manual request Jul 8, 2025
@aidanfnv aidanfnv added this pull request to the merge queue Jul 8, 2025
Merged via the queue into shader-slang:master with commit 0ab5151 Jul 8, 2025
17 checks passed
@aidanfnv aidanfnv deleted the fix/slangc-help branch July 22, 2025 18:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pr: non-breaking PRs without breaking changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants