Correct help output for waitfor RPC commands

This commit is contained in:
fanquake 2016-11-12 20:27:36 +08:00
parent db5e22e053
commit e3c4f7e182
No known key found for this signature in database
GPG key ID: 2EEB9F5CC09526C1

View file

@ -194,12 +194,12 @@ UniValue waitfornewblock(const JSONRPCRequest& request)
{ {
if (request.fHelp || request.params.size() > 1) if (request.fHelp || request.params.size() > 1)
throw runtime_error( throw runtime_error(
"waitfornewblock\n" "waitfornewblock (timeout)\n"
"\nWaits for a specific new block and returns useful info about it.\n" "\nWaits for a specific new block and returns useful info about it.\n"
"\nReturns the current block on timeout or exit.\n" "\nReturns the current block on timeout or exit.\n"
"\nArguments:\n" "\nArguments:\n"
"1. timeout (milliseconds) (int, optional, default=false)\n" "1. timeout (int, optional, default=0) Time in milliseconds to wait for a response. 0 indicates no timeout.\n"
"\nResult::\n" "\nResult:\n"
"{ (json object)\n" "{ (json object)\n"
" \"hash\" : { (string) The blockhash\n" " \"hash\" : { (string) The blockhash\n"
" \"height\" : { (int) Block height\n" " \"height\" : { (int) Block height\n"
@ -232,13 +232,13 @@ UniValue waitforblock(const JSONRPCRequest& request)
{ {
if (request.fHelp || request.params.size() < 1 || request.params.size() > 2) if (request.fHelp || request.params.size() < 1 || request.params.size() > 2)
throw runtime_error( throw runtime_error(
"waitforblock\n" "waitforblock <blockhash> (timeout)\n"
"\nWaits for a specific new block and returns useful info about it.\n" "\nWaits for a specific new block and returns useful info about it.\n"
"\nReturns the current block on timeout or exit.\n" "\nReturns the current block on timeout or exit.\n"
"\nArguments:\n" "\nArguments:\n"
"1. blockhash to wait for (string)\n" "1. blockhash to wait for (string)\n"
"2. timeout (milliseconds) (int, optional, default=false)\n" "2. timeout (int, optional, default=0) Time in milliseconds to wait for a response. 0 indicates no timeout.\n"
"\nResult::\n" "\nResult:\n"
"{ (json object)\n" "{ (json object)\n"
" \"hash\" : { (string) The blockhash\n" " \"hash\" : { (string) The blockhash\n"
" \"height\" : { (int) Block height\n" " \"height\" : { (int) Block height\n"
@ -274,14 +274,14 @@ UniValue waitforblockheight(const JSONRPCRequest& request)
{ {
if (request.fHelp || request.params.size() < 1 || request.params.size() > 2) if (request.fHelp || request.params.size() < 1 || request.params.size() > 2)
throw runtime_error( throw runtime_error(
"waitforblock\n" "waitforblockheight <blockheight> (timeout)\n"
"\nWaits for (at least) block height and returns the height and hash\n" "\nWaits for (at least) block height and returns the height and hash\n"
"\nof the current tip.\n" "of the current tip.\n"
"\nReturns the current block on timeout or exit.\n" "\nReturns the current block on timeout or exit.\n"
"\nArguments:\n" "\nArguments:\n"
"1. block height to wait for (int)\n" "1. block height to wait for (int)\n"
"2. timeout (milliseconds) (int, optional, default=false)\n" "2. timeout (int, optional, default=0) Time in milliseconds to wait for a response. 0 indicates no timeout.\n"
"\nResult::\n" "\nResult:\n"
"{ (json object)\n" "{ (json object)\n"
" \"hash\" : { (string) The blockhash\n" " \"hash\" : { (string) The blockhash\n"
" \"height\" : { (int) Block height\n" " \"height\" : { (int) Block height\n"