Skip to content

[NFC][opt] Improve help message #97805

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

Merged
merged 1 commit into from
Jul 5, 2024
Merged

[NFC][opt] Improve help message #97805

merged 1 commit into from
Jul 5, 2024

Conversation

omern1
Copy link
Member

@omern1 omern1 commented Jul 5, 2024

This patch changes all single quotes in the help text to double quotes for the sake of cross platform correctness.

The single quotes previously used in the help message are correct for bash and most other shells but aren't correct for the Windows command prompt as it only interprets double quotes in the manner intended in the help message.

This patch was prompted by the fact that if you aren't aware of the aformentioned quirk the single quotes result in very confusing error messages from the command prompt.

This patch changes all single quotes in the help text to
double quotes for the sake of cross platform correctness.

The single quotes previously used in the help message are correct for
bash and most other shells but aren't correct for the Windows command
prompt as it only interprets double quotes in the manner intended in the
help message.

This patch was prompted by the fact that if you aren't
aware of the aformentioned quirk the single quotes result in very
confusing error messages from the command prompt.
@omern1 omern1 changed the title [opt] Improve help message [NFC][opt] Improve help message Jul 5, 2024
@omern1 omern1 requested review from nikic and RKSimon July 5, 2024 10:21
Copy link
Contributor

@nikic nikic left a comment

Choose a reason for hiding this comment

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

Sounds reasonable. I don't think problematic special characters like $ typically occur in pass pipeline strings, so using double quotes is fine.

@omern1 omern1 merged commit d6e5b14 into llvm:main Jul 5, 2024
6 of 8 checks passed
@omern1 omern1 deleted the opt-help-fix branch July 5, 2024 10:43
kbluck pushed a commit to kbluck/llvm-project that referenced this pull request Jul 6, 2024
This patch changes all single quotes in the help text to double quotes
for the sake of cross platform correctness.

The single quotes previously used in the help message are correct for
bash and most other shells but aren't correct for the Windows command
prompt as it only interprets double quotes in the manner intended in the
help message.

This patch was prompted by the fact that if you aren't aware of the
aformentioned quirk the single quotes result in very confusing error
messages from the command prompt.
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.

2 participants