doc: fixed bitcoin-cli --help output to compatibility with help2man #13879
Conversation
This file contains hidden or 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
Currently help2man produces some unexpected commands in manual page file bitcoin-cli.1: 1) .TP + .IP for 'Usage' in DESCRIPTION section. Should be all .TP; 2) .TP + .IP for '-stdinrpcpass' in OPTIONS section. Should be only an .IP
Contributor
Note to reviewers: This pull request conflicts with the following ones:
If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first. |
| strUsage += "\nUsage:\n" | ||
| " bitcoin-cli [options] <command> [params] " + strprintf("Send command to %s", PACKAGE_NAME) + "\n" + | ||
| " bitcoin-cli [options] -named <command> [name=value] ... " + strprintf("Send command to %s (with named arguments)", PACKAGE_NAME) + "\n" + | ||
| " bitcoin-cli [options] -named <command> [name=value]... " + strprintf("Send command to %s (with named arguments)", PACKAGE_NAME) + "\n" + |
Contributor
There was a problem hiding this comment.
I think the solution in #13872 is better for help2man.
Member
Author
There was a problem hiding this comment.
Member
|
needs rebase (if still necessary) after #13872 |
Contributor
| Needs rebase |
Member
Author
|
Pull request after rebase: #13905 |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
5 participants
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.
Currently help2man produces some unexpected commands in the manual page file bitcoin-cli.1: