While reviewing a different PR (see #742 ) hebasto suggested that the help for bitcoin-qt should be updated to reflect the fact that bitcoin-qt supports an optional BIP21 URI parameter.
Since this reflects actual behaviour of bitcoin-qt and is independent of whether or not the other PR gets merged, I created this simple PR to fix the help message.
The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.
See the guideline for information on the review process.
| Type | Reviewers |
|---|---|
| ACK | kristapsk, pablomartin4btc, hebasto |
| Concept ACK | RandyMcMillan |
| Stale ACK | jarolrod |
If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.
No conflicts as of last run.
57@@ -58,7 +58,8 @@ HelpMessageDialog::HelpMessageDialog(QWidget *parent, bool about) :
58 ui->helpMessage->setVisible(false);
59 } else {
60 setWindowTitle(tr("Command-line options"));
61- QString header = "Usage: bitcoin-qt [command-line options] \n";
62+ QString header = "Usage: bitcoin-qt [command-line options] [BIP21 URI] \n\n"
[URI] here, and if BIP21 is mentioned, only do so in the explanation below.
I think it can be removed, it doesn’t make any difference. I couldn’t find any other reference in the code of such a thing (extra spaces at the end of a line before an \n). I think it was some formatting logic left behind.
Regarding its historical origins, it seems that it was coming from the bitcoind/ bitcoin-cli helps and copied over (#13872).
You can still see it at some places (exactly the same 22 spaces):
Why not the complete syntax representation of the BIP21 command?
0 bitcoinurn = "bitcoin:" bitcoinaddress [ "?" bitcoinparams ]
1 bitcoinaddress = *base58
2 bitcoinparams = bitcoinparam [ "&" bitcoinparams ]
3 bitcoinparam = [ amountparam / labelparam / messageparam / otherparam / reqparam ]
4 amountparam = "amount=" *digit [ "." *digit ]
5 labelparam = "label=" *qchar
6 messageparam = "message=" *qchar
7 otherparam = qchar *qchar [ "=" *qchar ]
8 reqparam = "req-" qchar *qchar [ "=" *qchar ]
Also, I’d remove 1 space after “Usage:”, so the start of “bitcoind” matches the alignment of the options helps.
0 QString header = "Usage: bitcoin-qt [command-line options] [BIP21 URI] \n\n"
57@@ -58,7 +58,8 @@ HelpMessageDialog::HelpMessageDialog(QWidget *parent, bool about) :
58 ui->helpMessage->setVisible(false);
59 } else {
60 setWindowTitle(tr("Command-line options"));
61- QString header = "Usage: bitcoin-qt [command-line options] \n";
62+ QString header = "Usage: bitcoin-qt [command-line options] [URI]\n\n"
63+ "Optional [URI] is a bitcoin address in BIP21 URI format.\n";
Square brackets mean that URI option is optional. Either use “[URI]” or “Optional URI” below, not “Optional [URI]”.
0 "Optional URI is a bitcoin address in BIP21 URI format.\n";
