rpc: Make rpc documentation not depend on call-time rpc args #18499

pull MarcoFalke wants to merge 1 commits into bitcoin:master from MarcoFalke:2004-rpcStaticDoc changing 2 files +8 −15

MarcoFalke commented at 4:24 PM on April 1, 2020: member

This is required to host the documentation on a static resource (like a website or pdf)
rpc: Make rpc documentation not depend on rpc args fab32557f2
MarcoFalke force-pushed on Apr 1, 2020
MarcoFalke renamed this:
~~rpc: Make rpc documentation not depend on rpc args~~
rpc: Make rpc documentation not depend on call-time rpc args
on Apr 1, 2020

in src/wallet/rpcwallet.cpp:41 in fab32557f2

  37 | @@ -38,6 +38,7 @@
  38 |  
  39 |  
  40 |  static const std::string WALLET_ENDPOINT_BASE = "/wallet/";
  41 | +static const std::string HELP_REQUIRING_PASSPHRASE{"\nRequires wallet passphrase to be set with walletpassphrase call if wallet is encrypted.\n"};

emilengler commented at 4:28 PM on April 1, 2020:

nit: The line above is not using a C++11 list init. I would change it to a C one to keep it coherent.

emilengler commented at 4:30 PM on April 1, 2020: contributor

Concept ACK, a static documentation is most likely a better choice
theStack commented at 4:36 PM on April 1, 2020: contributor

Concept ACK
promag commented at 4:45 PM on April 1, 2020: member

ACK fab32557f25c93fecb7bb33f78fdf3e9160c89e5.
emilengler commented at 4:48 PM on April 1, 2020: contributor

utACK fab32557f25c93fecb7bb33f78fdf3e9160c89e5
DrahtBot commented at 5:10 PM on April 1, 2020: contributor


The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.



Conflicts

Reviewers, this pull request conflicts with the following ones:
- #18354 (Protect wallet by using shared pointers by bvbfan)
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 Apr 1, 2020 from issue Use shared pointers only in validation interface by bvbfan
DrahtBot added the label RPC/REST/ZMQ on Apr 1, 2020
DrahtBot added the label Wallet on Apr 1, 2020
MarcoFalke merged this on Apr 3, 2020
MarcoFalke closed this on Apr 3, 2020
MarcoFalke deleted the branch on Apr 3, 2020
MarkLTZ cross-referenced this on Apr 4, 2020 from issue Bitcoin PR tracking by MarkLTZ
MarcoFalke cross-referenced this on Apr 6, 2020 from issue rpc: Make verifychain default values static, not depend on global args by MarcoFalke
sidhujag referenced this in commit 3978ac9eab on Apr 8, 2020
MarcoFalke referenced this in commit a840dab2a5 on Apr 10, 2020
sidhujag referenced this in commit 16258a650c on Apr 13, 2020
deadalnix referenced this in commit f6e8143920 on Jan 14, 2021
bitcoin locked this on Feb 15, 2022

Contributors

Labels

Linked (view graph)

#18541 rpc: Make verifychain default values static, not depend on global args

rpc: Make rpc documentation not depend on call-time rpc args #18499

Conflicts