Skip to content

Omit "Internal" category from default help text output #8013

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Aug 1, 2025
Merged

Omit "Internal" category from default help text output #8013

merged 1 commit into from
Aug 1, 2025
+2 −2

Conversation

aidanfnv
Copy link
Contributor

@aidanfnv aidanfnv commented Jul 31, 2025 •
edited
Loading

For #7969

This changes the output text of slangc -h to not print the "Internal" category unless explicitly specified, as those options are intended for internal Slang dev use. The category can still be printed on its own with slangc -h Internal, and is listed in the available categories under the "Getting Help for Specific Categories" note at the end of the output of slangc -h.
The markdown help output is not affected.

Before: 468 lines of help text, 3246 words, 39448 characters
After: 447 lines, 3107 words, 38313 characters
Diff: -21 lines (approx. 4.5%), -139 words (approx. 4.3%), -1135 characters (approx. 2.9%)

@aidanfnv aidanfnv requested a review from jkwak-work July 31, 2025 23:34
@aidanfnv aidanfnv added the pr: non-breaking PRs without breaking changes label Jul 31, 2025
@aidanfnv aidanfnv requested a review from a team as a code owner July 31, 2025 23:34
jkwak-work
jkwak-work approved these changes Jul 31, 2025
View reviewed changes
Copy link
Collaborator

@jkwak-work jkwak-work left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

But how do we know the command -h internal exist in the first place?

@aidanfnv
Copy link
Contributor Author

But how do we know the command -h internal exist in the first place?

At the end of the slangc -h output, we have a note that says:

To get help for a specific category of options or values, use: slangc -h <help-category>
  <help-category> can be: General, Target, Downstream, Debugging, Repro, Experimental, Internal, Deprecated, compiler,
  language, language-version, archive-type, line-directive-mode, debug-info-format, fp-mode, fp-denormal-mode,
  help-style, optimization-level, debug-level, file-system-type, source-embed-style, target, stage, vulkan-shift,
  capability, file-extension, help-category

and "Internal" is listed there.

@aidanfnv aidanfnv enabled auto-merge July 31, 2025 23:57
@aidanfnv aidanfnv added this pull request to the merge queue Aug 1, 2025
Merged via the queue into shader-slang:master with commit 96346cd Aug 1, 2025
19 checks passed
@aidanfnv aidanfnv mentioned this pull request Aug 1, 2025
Closed
@aidanfnv aidanfnv deleted the fix/slangc-help-internal branch August 1, 2025 17:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jkwak-work jkwak-work jkwak-work approved these changes

Assignees
No one assigned
Labels
pr: non-breaking PRs without breaking changes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@aidanfnv @jkwak-work