Skip to content
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.

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

Support -h/--help for all programs #1620

Merged
merged 2 commits into from
Jan 22, 2025
Merged

Support -h/--help for all programs #1620

merged 2 commits into from
Jan 22, 2025

Conversation

Rangi42
Copy link
Contributor

@Rangi42 Rangi42 commented Jan 18, 2025

Fixes #1608

Screen Shot 2025-01-18 at 00 14 36
Screen Shot 2025-01-18 at 00 15 13

@Rangi42 Rangi42 added enhancement Typically new features; lesser priority than bugs rgbasm This affects RGBASM rgblink This affects RGBLINK rgbfix This affects RGBFIX rgbgfx This affects RGBGFX labels Jan 18, 2025
@Rangi42 Rangi42 added this to the 0.9.1 milestone Jan 18, 2025
@Rangi42 Rangi42 requested a review from ISSOtm January 18, 2025 07:13
ISSOtm
ISSOtm previously requested changes Jan 18, 2025
contrib/zsh_compl/_rgbasm Outdated Show resolved Hide resolved
@Rangi42 Rangi42 requested a review from ISSOtm January 18, 2025 18:07
Copy link
Member

@ISSOtm ISSOtm left a comment

Choose a reason for hiding this comment

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

I think that this would warrant a separate rgbasm --help line, actually. Since this is not meant to be used with the rest.

@Rangi42
Copy link
Contributor Author

Rangi42 commented Jan 19, 2025

I think that this would warrant a separate rgbasm --help line, actually. Since this is not meant to be used with the rest.

I'm not sure what you mean by "a separate line". h is treated the same way as V so far.

I see that the Rust-rewritten RGBGFX supports a -h flag for basic usage information, same as here, or a long --help flag for more verbose usage information, though still not as "comprehensive" as the man page. And instead of printing the whole usage information, an erroneous flag like --foobar just prints "For more information, try --help." Also the usage information printed by -h/--help lists -h,--help and -V,--version last after all the other arguments. (Although this is because the summary string on top just says "[OPTIONS]", so it doesn't have an argumentless group like RGBASM's [-EhVvw] in the first place.)

Anyway, I'm not sure what lesson to take from all that. List --help last among the "useful options" for each program? That's probably a good idea, but we'd still leave h and V in the argumentless groups.

@Rangi42 Rangi42 requested review from ISSOtm and removed request for ISSOtm January 22, 2025 02:16
@Rangi42 Rangi42 merged commit d9654b7 into gbdev:master Jan 22, 2025
25 checks passed
@Rangi42 Rangi42 deleted the help branch January 22, 2025 02:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Typically new features; lesser priority than bugs rgbasm This affects RGBASM rgbfix This affects RGBFIX rgbgfx This affects RGBGFX rgblink This affects RGBLINK
Projects
None yet
Development

Successfully merging this pull request may close these issues.

-h/--help flag for all programs
2 participants