Skip to content

Commit fa5e045

Browse files
author
MarcoFalke
committed
rpc: Documentation fixups
1 parent fa91e8e commit fa5e045

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

src/rpc/misc.cpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -461,7 +461,7 @@ static UniValue echo(const JSONRPCRequest& request)
461461
throw std::runtime_error(
462462
RPCHelpMan{"echo|echojson ...",
463463
"\nSimply echo back the input arguments. This command is for testing.\n"
464-
"\nThe difference between echo and echojson is that echojson has argument conversion enabled in the client-side table in"
464+
"\nThe difference between echo and echojson is that echojson has argument conversion enabled in the client-side table in "
465465
"bitcoin-cli and the GUI. There is no server-side difference.",
466466
{}}
467467
.ToString() +

test/lint/lint-rpc-help.sh

+7
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,17 @@
33
# Copyright (c) 2018 The Bitcoin Core developers
44
# Distributed under the MIT software license, see the accompanying
55
# file COPYING or http://www.opensource.org/licenses/mit-license.php.
6+
#
7+
# Check that all RPC help texts are generated by RPCHelpMan.
68

79
export LC_ALL=C
810

911
EXIT_CODE=0
12+
13+
# Assume that all multiline strings passed into a runtime_error are help texts.
14+
# This is potentially fragile, but the linter is only temporary and can safely
15+
# be removed early 2019.
16+
1017
non_autogenerated_help=$(grep --perl-regexp --null-data --only-matching 'runtime_error\(\n\s*".*\\n"\n' $(git ls-files -- "*.cpp"))
1118
if [[ ${non_autogenerated_help} != "" ]]; then
1219
echo "Must use RPCHelpMan to generate the help for the following RPC methods:"

0 commit comments

Comments
 (0)