rpc: Make rpc documentation not depend on call-time rpc args #18499
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
maflcko
force-pushed
the
2004-rpcStaticDoc
branch
from
fa0c6c2 to
fab3255
Compare
maflcko
changed the title
cvengler
reviewed
Apr 1, 2020
Contributor
cvengler
left a comment
cvengler
left a comment
There was a problem hiding this comment.
Concept ACK, a static documentation is most likely a better choice
|
|
||
|
|
||
| static const std::string WALLET_ENDPOINT_BASE = "/wallet/"; | ||
| static const std::string HELP_REQUIRING_PASSPHRASE{"\nRequires wallet passphrase to be set with walletpassphrase call if wallet is encrypted.\n"}; |
Contributor
There was a problem hiding this comment.
nit: The line above is not using a C++11 list init. I would change it to a C one to keep it coherent.
promag
reviewed
Apr 1, 2020
Contributor
|
utACK fab3255 |
Contributor
|
The following sections might be updated with supplementary metadata relevant to reviewers and maintainers. ConflictsReviewers, 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. |
sidhujag
pushed a commit
to syscoin/syscoin
that referenced
this pull request
Apr 8, 2020
…ime rpc args fab3255 rpc: Make rpc documentation not depend on rpc args (MarcoFalke) Pull request description: This is required to host the documentation on a static resource (like a website or pdf) ACKs for top commit: emilengler: utACK fab3255 promag: ACK fab3255. Tree-SHA512: 3ca2691c7fbd5f17c75df2887753da152f66521dcb7dee4c29af6339fdea011cecdd51f825b96bde9c6aaf82f4d915cbd5aacb52e4eae3898d9dbc216f627171
maflcko
pushed a commit
to maflcko/bitcoin-core
that referenced
this pull request
Apr 10, 2020
… depend on global args fad691c rpc: Make verifychain default values static, not depend on global args (MarcoFalke) Pull request description: This fixes several issues: * The documentation is not compile-time static and depends on run-time arguments, making it impossible to host it on a static resource like a website or pdf. See also a similar change in the wallet rpc code: bitcoin#18499 * The same call (relying on default values) will run different code on different machines, depending on the command line args that were used to start the server. This might lead to hard-to-debug-remote issues. This is a small behaviour change, and I will add release notes. ACKs for top commit: theStack: ACK bitcoin@fad691c promag: Code review ACK fad691c. Tree-SHA512: 1c7a253ff0ec13a973b10d3777b71c70954ded5805b65a3ab06317327014de4cd0601d71d30c6ce89a581722c150cb5567acc1bd3e0c789cb51bab6ef0dcfc4a
sidhujag
pushed a commit
to syscoin/syscoin
that referenced
this pull request
Apr 13, 2020
… depend on global args fad691c rpc: Make verifychain default values static, not depend on global args (MarcoFalke) Pull request description: This fixes several issues: * The documentation is not compile-time static and depends on run-time arguments, making it impossible to host it on a static resource like a website or pdf. See also a similar change in the wallet rpc code: bitcoin#18499 * The same call (relying on default values) will run different code on different machines, depending on the command line args that were used to start the server. This might lead to hard-to-debug-remote issues. This is a small behaviour change, and I will add release notes. ACKs for top commit: theStack: ACK bitcoin@fad691c promag: Code review ACK fad691c. Tree-SHA512: 1c7a253ff0ec13a973b10d3777b71c70954ded5805b65a3ab06317327014de4cd0601d71d30c6ce89a581722c150cb5567acc1bd3e0c789cb51bab6ef0dcfc4a
deadalnix
pushed a commit
to Bitcoin-ABC/bitcoin-abc
that referenced
this pull request
Jan 14, 2021
Summary: > This is required to host the documentation on a static resource (like a website or pdf) Thisis a backport of Core [[bitcoin/bitcoin#18499 | PR18499]] Test Plan: Display the help message of one of the affected commands: ``` for COMMAND in sendtoaddress signmessage sendmany keypoolrefill signrawtransactionwithwallet sethdseed walletprocesspsbt do src/bitcoin-cli help $COMMAND done ``` Reviewers: #bitcoin_abc, majcosta Reviewed By: #bitcoin_abc, majcosta Differential Revision: https://reviews.bitcoinabc.org/D8902
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.
This is required to host the documentation on a static resource (like a website or pdf)