LBRYCommunity/lbrycrd
1
0
Fork 0
Code Issues 29 Pull requests 1 Projects Releases 32 Packages Wiki Activity

Merge #13872: [docs] Reformat -help output for help2man

Browse source 
7272fdcfe7 [docs] Reformat -help output for help2man (Tim Ruffing)

Pull request description:

  This commit slightly changes the format of the "Usage" strings in CLI
  `-help` messages to meet the expection of the help2man tool, which we
  use to generate man pages. On the way, we remove a few calls to
  `strprintf()`, which became superficial after commit 32fbfda.

  Before:
  ![screenshot from 2018-08-04 12-11-25](https://user-images.githubusercontent.com/1071625/43675564-6e2e016c-97e2-11e8-8de7-0912a4088efd.png)
  After:
  ![screenshot from 2018-08-04 12-11-46](https://user-images.githubusercontent.com/1071625/43675566-712d7032-97e2-11e8-85a7-5decc6dcb4b2.png)

Tree-SHA512: 9752ee0d0fde0b084e00232609866291ff493f4feb45919279b0f142b04635c049ddd2bf71ff6ad57d4ae1ed37103348640d253bb4f0b3e16b7fd2bb4b2a6fba
This commit is contained in:
Wladimir J. van der Laan 2018-08-07 10:19:09 +02:00
commit 37ab117a87
No known key found for this signature in database
GPG key ID: 1E4AED62986CD25D
4 changed files with 14 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
src/bitcoin-cli.cpp
View file

@ -104,14 +104,13 @@ static int AppInitRPC(int argc, char* argv[])
return EXIT_FAILURE; return EXIT_FAILURE;
} }
if (argc < 2 || HelpRequested(gArgs) || gArgs.IsArgSet("-version")) { if (argc < 2 || HelpRequested(gArgs) || gArgs.IsArgSet("-version")) {
std::string strUsage = strprintf("%s RPC client version", PACKAGE_NAME) + " " + FormatFullVersion() + "\n"; std::string strUsage = PACKAGE_NAME " RPC client version " + FormatFullVersion() + "\n";
if (!gArgs.IsArgSet("-version")) { if (!gArgs.IsArgSet("-version")) {
strUsage += "\nUsage:\n" strUsage += "\n"
" bitcoin-cli [options] <command> [params] " + strprintf("Send command to %s", PACKAGE_NAME) + "\n" + "Usage: bitcoin-cli [options] <command> [params] Send command to " PACKAGE_NAME "\n"
" bitcoin-cli [options] -named <command> [name=value] ... " + strprintf("Send command to %s (with named arguments)", PACKAGE_NAME) + "\n" + "or: bitcoin-cli [options] -named <command> [name=value]... Send command to " PACKAGE_NAME " (with named arguments)\n"
" bitcoin-cli [options] help List commands\n" + "or: bitcoin-cli [options] help List commands\n"
" bitcoin-cli [options] help <command> Get help for a command\n"; "or: bitcoin-cli [options] help <command> Get help for a command\n";
strUsage += "\n" + gArgs.GetHelpMessage(); strUsage += "\n" + gArgs.GetHelpMessage();
} }

9
src/bitcoin-tx.cpp
View file

@ -98,11 +98,10 @@ static int AppInitRawTx(int argc, char* argv[])
if (argc < 2 || HelpRequested(gArgs)) { if (argc < 2 || HelpRequested(gArgs)) {
// First part of help message is specific to this utility // First part of help message is specific to this utility
std::string strUsage = strprintf("%s bitcoin-tx utility version", PACKAGE_NAME) + " " + FormatFullVersion() + "\n\n" + std::string strUsage = PACKAGE_NAME " bitcoin-tx utility version " + FormatFullVersion() + "\n\n" +
"Usage:\n" "Usage: bitcoin-tx [options] <hex-tx> [commands] Update hex-encoded bitcoin transaction\n" +
" bitcoin-tx [options] <hex-tx> [commands] Update hex-encoded bitcoin transaction\n" + "or: bitcoin-tx [options] -create [commands] Create hex-encoded bitcoin transaction\n" +
" bitcoin-tx [options] -create [commands] Create hex-encoded bitcoin transaction\n" + "\n";
"\n";
strUsage += gArgs.GetHelpMessage(); strUsage += gArgs.GetHelpMessage();
fprintf(stdout, "%s", strUsage.c_str()); fprintf(stdout, "%s", strUsage.c_str());

6
src/bitcoind.cpp
View file

@ -71,7 +71,7 @@ static bool AppInit(int argc, char* argv[])
// Process help and version before taking care about datadir // Process help and version before taking care about datadir
if (HelpRequested(gArgs) || gArgs.IsArgSet("-version")) { if (HelpRequested(gArgs) || gArgs.IsArgSet("-version")) {
std::string strUsage = strprintf("%s Daemon", PACKAGE_NAME) + " version " + FormatFullVersion() + "\n"; std::string strUsage = PACKAGE_NAME " Daemon version " + FormatFullVersion() + "\n";
if (gArgs.IsArgSet("-version")) if (gArgs.IsArgSet("-version"))
{ {
@ -79,9 +79,7 @@ static bool AppInit(int argc, char* argv[])
} }
else else
{ {
strUsage += "\nUsage:\n" strUsage += "\nUsage: bitcoind [options] Start " PACKAGE_NAME " Daemon\n";
" bitcoind [options] " + strprintf("Start %s Daemon", PACKAGE_NAME) + "\n";
strUsage += "\n" + gArgs.GetHelpMessage(); strUsage += "\n" + gArgs.GetHelpMessage();
} }

5
src/qt/utilitydialog.cpp
View file

@ -70,8 +70,7 @@ HelpMessageDialog::HelpMessageDialog(interfaces::Node& node, QWidget *parent, bo
ui->helpMessage->setVisible(false); ui->helpMessage->setVisible(false);
} else { } else {
setWindowTitle(tr("Command-line options")); setWindowTitle(tr("Command-line options"));
QString header = "Usage:\n" QString header = "Usage: bitcoin-qt [command-line options] \n";
" bitcoin-qt [command-line options] \n";
QTextCursor cursor(ui->helpMessage->document()); QTextCursor cursor(ui->helpMessage->document());
cursor.insertText(version); cursor.insertText(version);
cursor.insertBlock(); cursor.insertBlock();
@ -80,7 +79,7 @@ HelpMessageDialog::HelpMessageDialog(interfaces::Node& node, QWidget *parent, bo
std::string strUsage = gArgs.GetHelpMessage(); std::string strUsage = gArgs.GetHelpMessage();
QString coreOptions = QString::fromStdString(strUsage); QString coreOptions = QString::fromStdString(strUsage);
text = version + "\n" + header + "\n" + coreOptions; text = version + "\n\n" + header + "\n" + coreOptions;
QTextTableFormat tf; QTextTableFormat tf;
tf.setBorderStyle(QTextFrameFormat::BorderStyle_None); tf.setBorderStyle(QTextFrameFormat::BorderStyle_None);