systemctl: be nice to users and give hint about "-.mount" #11065
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
https://bugzilla.redhat.com/show_bug.cgi?id=1656639 Using "--" is a trick that is hard to discover. Let's give users a hint: $ build/systemctl status -.service build/systemctl: invalid option -- '.' Hint: to specify units starting with a dash, use "--": build/systemctl [OPTIONS...] {COMMAND} -- -.service ... I use program_invocation_name because that's what getopt seems to use. "::" is used in the option string so that getopt doesn't complain about a missing argument in case somebody passes "-." as the argument. After all "." is not a real option.
keszybz
force-pushed
the
systemctl-help-hint
branch
from
f55dbf8
to
7a5165f
Compare
|
Lgtm. |
poettering
reviewed
Dec 7, 2018
| /* Output an error mimicking getopt, and print a hint afterwards */ | ||
| log_error("%s: invalid option -- '.'", program_invocation_name); | ||
| log_notice("Hint: to specify units starting with a dash, use \"--\":\n" | ||
| " %s [OPTIONS...] {COMMAND} -- -.%s ...", |
There was a problem hiding this comment.
maybe add "Example:" to this line to clarify that this is an example?
There was a problem hiding this comment.
It's actually a bit more than an example, because it uses optarg to construct a part of the correct commandline. Alos, there's an ellipsis at the end, so I think it's pretty clear that this is not the full thing.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
If people like this, something like this can be added to the other commands that take a unit name.
(Please use 'rebase & merge', commits in this PR are unrelated.)