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

improve command syntax in help text #52

Merged
merged 2 commits into from
Jan 10, 2025

Conversation

rohieb
Copy link
Contributor

@rohieb rohieb commented Jan 8, 2025

Some of these commands can take a useries too, which is not a commit-ish. Also some commands can work on the currently checked-out umerge or utag, so in this case an argument is optional.

umpf Outdated Show resolved Hide resolved
umpf Outdated Show resolved Hide resolved
@michaelolbrich
Copy link
Member

And your s-o-b is missing.

* Some of these commands can take a useries, which is not a commit-ish
* Some commands can work on the currently checked-out umerge or utag, so
  in this case an argument is optional; add a short note for that.
* 'tag' can work on commit-ishs too, mention that use case.

Signed-off-by: Roland Hieber <[email protected]>
The initial tab is necessary and eaten by the <<- redirection, but the
rest of the line should stay correctly aligned even if the tab size of
the terminal is configured differently.

Signed-off-by: Roland Hieber <[email protected]>
@michaelolbrich michaelolbrich merged commit 10a5951 into pengutronix:master Jan 10, 2025
2 checks passed
@rohieb rohieb deleted the help-commands branch January 10, 2025 09:53
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