Skip to content

CLI: Refactor help output into categorized chunks#2602

Merged
HansKristian-Work merged 1 commit intoKhronosGroup:mainfrom
Devesh99:feature/chunked-help
Feb 26, 2026
Merged

CLI: Refactor help output into categorized chunks#2602
HansKristian-Work merged 1 commit intoKhronosGroup:mainfrom
Devesh99:feature/chunked-help

Conversation

@Devesh99
Copy link
Copy Markdown
Contributor

The current --help output for spirv-cross is very large, which can be overwhelming for users. This PR refactors the help system to provide a more organized experience.

Changes

  • Implemented categorized help flags: --help-glsl, --help-msl, --help-hlsl, and --help-obscure.
  • Added --help-all to display the full original help output.
  • Updated the default --help output to be more concise:
    • Displays basic usage, backend selection, and common options by default.
    • Lists the new category-specific flags for detailed language options.

Fixes #2601

@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Feb 21, 2026

CLA assistant check
All committers have signed the CLA.

Copy link
Copy Markdown
Contributor

@HansKristian-Work HansKristian-Work left a comment

Choose a reason for hiding this comment

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

Seems useful, yes.

@HansKristian-Work HansKristian-Work merged commit 1a53b18 into KhronosGroup:main Feb 26, 2026
10 checks passed
@Devesh99 Devesh99 deleted the feature/chunked-help branch March 8, 2026 14:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Feature Request: Refactor CLI help output into categories

3 participants