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

[OptTable] Make new lines in help text respect indentation #75366

Merged
merged 2 commits into from
Dec 15, 2023

Conversation

avillega
Copy link
Contributor

@avillega avillega commented Dec 13, 2023

With this changes, new lines in the HelpText defined in OptTable have the same indentation as the first line.

Before, the help output will look something like:

--color=<value>       Whether to use color when
symbolizing log markup: always, auto, never

With this change:

--color=<value>       Whether to use color when
                      symbolizing log markup: always, auto, never

With this changes, new lines in the HelpText defined
in OptTable have the same indentation as the first line.

Before, the help output will look something like:

```
--color=<value>       Whether to use color when
symbolizing log markup: always, auto, never
```

With this change:

```
--color=<value>       - Whether to use color when
                        symbolizing log markup: always, auto, never
```

Note the "-" at the beginning of the help text in the new version,
it was added to clearly separate the HelpText of the different
options.
Copy link
Member

@MaskRay MaskRay left a comment

Choose a reason for hiding this comment

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

Remove

Note the "-" at the beginning of the help text in the new version, it was added to clearly separate the HelpText of the different options.

llvm/unittests/Option/Opts.td Outdated Show resolved Hide resolved
Copy link
Collaborator

@jh7370 jh7370 left a comment

Choose a reason for hiding this comment

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

LGTM, once @MaskRay's comments addressed.

@avillega avillega merged commit 8d5bb54 into llvm:main Dec 15, 2023
4 checks passed
@avillega avillega deleted the opt-help-improv branch December 15, 2023 00:05
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.

None yet

3 participants