doc: fixed bitcoin-cli --help output to compatibility with help2man #13879

pull hebasto wants to merge 1 commits into bitcoin:master from hebasto:bitcoin-cli-help2man changing 1 files +2 −2

hebasto commented at 9:45 PM on August 4, 2018: member
Currently help2man produces some unexpected commands in the manual page file bitcoin-cli.1:
- .TP + .IP for 'Usage' in DESCRIPTION section. Should be all .TP;
- .TP + .IP for '-stdinrpcpass' in OPTIONS section. Should be only an .IP

doc: fixed bitcoin-cli --help output to compatibility with help2man

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

b86f7ee020

DrahtBot commented at 12:13 AM on August 5, 2018: contributor
Note to reviewers: This pull request conflicts with the following ones:
- #13872 ([docs] Reformat -help output for help2man by real-or-random)
- #13716 (bitcoin-cli: -stdinwalletpassphrase and non-echo stdin passwords by kallewoof)
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.
DrahtBot cross-referenced this on Aug 5, 2018 from issue [docs] Reformat -help output for help2man by real-or-random

in src/bitcoin-cli.cpp:111 in b86f7ee020

 107 | @@ -108,7 +108,7 @@ static int AppInitRPC(int argc, char* argv[])
 108 |          if (!gArgs.IsArgSet("-version")) {
 109 |              strUsage += "\nUsage:\n"
 110 |                    "  bitcoin-cli [options] <command> [params]  " + strprintf("Send command to %s", PACKAGE_NAME) + "\n" +
 111 | -                  "  bitcoin-cli [options] -named <command> [name=value] ... " + strprintf("Send command to %s (with named arguments)", PACKAGE_NAME) + "\n" +
 112 | +                  "  bitcoin-cli [options] -named <command> [name=value]...  " + strprintf("Send command to %s (with named arguments)", PACKAGE_NAME) + "\n" +

real-or-random commented at 12:31 AM on August 5, 2018:

I think the solution in #13872 is better for help2man.

hebasto commented at 9:06 AM on August 5, 2018:

#13872 introduces SYNOPSIS section to the all bitcoind, bitcoin-qt and utilities manual pages. I think that is a good move. And, as a side effect, #13872 fixes one of two bugs in bitcoin-cli --help output.

#13879 just fixes all found bugs in bitcoin-cli --help output and is safe for the whole code.

DrahtBot cross-referenced this on Aug 5, 2018 from issue bitcoin-cli: -stdinwalletpassphrase and non-echo stdin passwords by kallewoof
fanquake added the label Docs on Aug 5, 2018
laanwj commented at 8:36 AM on August 7, 2018: member

needs rebase (if still necessary) after #13872
DrahtBot commented at 10:28 AM on August 7, 2018: contributor

Needs rebase
DrahtBot added the label Needs rebase on Aug 7, 2018
laanwj cross-referenced this on Aug 7, 2018 from issue 0.17: Pre-branch maintenance by DrahtBot
hebasto cross-referenced this on Aug 7, 2018 from issue docs: fixed bitcoin-cli -help output for help2man by hebasto
hebasto commented at 6:56 PM on August 7, 2018: member

Pull request after rebase: #13905
hebasto closed this on Aug 7, 2018
bitcoin locked this on Aug 8, 2018
hebasto deleted the branch on Aug 13, 2018
fanquake removed the label Needs rebase on Aug 26, 2018

Contributors

Labels

Linked (view graph)

#13780 0.17: Pre-branch maintenance #13905 docs: fixed bitcoin-cli -help output for help2man