-
Notifications
You must be signed in to change notification settings - Fork 38.7k
Issue #1865 - Clean up RPC help messages #3184
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Based on the proposal, update the help message of rpc methods - strings arguments are in double quotes rather than square brackets - numeric arguments have no quotes (and no default value) - optional parameters are surrounded by round brackets - json arguments are strings but don't use double quotes Added 3 sections for the details - Arguments: lists each argument, it's type, required or not, a default, and a description - Result: The method result, with json format if applicable, type, and a description - Examples: examples calls using bitcoin-cli and curl for json rpc call Problems - maybe this is too verbose - lines might be too long - description are not good or complete - examples may be too much
|
Looks good |
src/rpcblockchain.cpp
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing a space here
|
ACK, this is certainly an improvement over what is there |
|
There seems to be a lot of duplication (the example command lines in particular). Mind moving the generation of those to a common method? |
|
Thanks for the comments. I have done a few updates. |
|
Automatic sanity-testing: FAILED BUILD/TEST, see http://jenkins.bluematt.me/pull-tester/53b1b1ade8b4d6605fbf145bb62489627cecae68 for binaries and test log. This could happen for one of several reasons:
If you believe this to be in error, please ping BlueMatt on freenode or TheBlueMatt here. This test script verifies pulls every time they are updated. It, however, dies sometimes and fails to test properly. If you are waiting on a test, please check timestamps to verify that the test.log is moving at http://jenkins.bluematt.me/pull-tester/current/ |
The examples are generated from a common method (see bitcoinrpc.h). This also fixes is missing space in rpcblockchain.cpp:101 Some other cleanup
|
@sje1 what problem do you have building head on centos 5? |
|
i was building 8.0.5 by building each dependency (boost, db, openssl), then setting the paths in the Makefile. on centos 5, not sure how to update or install the latest autoconf
on centos 6, autoconf is ok, i couldn't get it to use my boost but it worked with the built-in one, but key.cpp fails with lots of undefined references
|
|
The key.cpp errors could have to do with Centos not including the ecc parts of OpenSSL? I remember there was the same issue with Fedora due to patents. Though this would be nothing new with autoconf. Edit: But is this ready for merging otherwise? |
|
Sounds like you're building against a non-ECC OpenSSL build, indeed. |
|
You need to use fully qualified std::string in the .h file, hence the pull tester errors: |
|
@sje1 any luck yet? If not, mind if I take over this pull request and get it merged before other RPC changes? |
|
Continued in #3246 |
|
@laanwj thanks for taking over, i haven't figured out how to build yet :) |
…tcoin#3184) * From 2 best sets with the same `nTotal` in ApproximateBestSubset prefer the one with less inputs * There is no reason to run ApproximateBestSubset again if nMinChange is 0 * Apply review suggestions
…tcoin#3184) * From 2 best sets with the same `nTotal` in ApproximateBestSubset prefer the one with less inputs * There is no reason to run ApproximateBestSubset again if nMinChange is 0 * Apply review suggestions
Some expanded docs for the rpc commands...comments? terrible?
Based on the proposal, update the help message of rpc methods
Added 3 sections for the details
Problems