Skip to content

Commit 8987a6c

Browse files
authored
Update "debug" rpc help text (#2810)
* Update "debug" rpc help text * add missing "qt" category * add a note about non-matching categories
1 parent 4b4234f commit 8987a6c

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

src/rpc/misc.cpp

+11-3
Original file line numberDiff line numberDiff line change
@@ -123,10 +123,18 @@ UniValue debug(const JSONRPCRequest& request)
123123
{
124124
if (request.fHelp || request.params.size() != 1)
125125
throw std::runtime_error(
126-
"debug ( 0|1|addrman|alert|bench|coindb|db|lock|rand|rpc|selectcoins|mempool"
127-
"|mempoolrej|net|proxy|prune|http|libevent|tor|zmq|"
128-
"dash|privatesend|instantsend|masternode|spork|keepass|mnpayments|gobject )\n"
126+
"debug \"category\"\n"
129127
"Change debug category on the fly. Specify single category or use '+' to specify many.\n"
128+
"\nArguments:\n"
129+
"1. \"category\" (string, required) The name of the debug category to turn on. Can be one of the following:\n"
130+
" addrman, alert, bench, cmpctblock, coindb, db, http, leveldb, libevent, lock, mempool,\n"
131+
" mempoolrej, net, proxy, prune, qt, rand, reindex, rpc, selectcoins, tor, zmq, dash\n"
132+
" (or specifically: chainlocks, gobject, instantsend, keepass, llmq, llmq-dkg, llmq-sigs,\n"
133+
" masternode, mnpayments, mnsync, privatesend, spork).\n"
134+
" Can also use \"1\" to turn all categories on at once and \"0\" to turn them off.\n"
135+
" Note: If specified category doesn't match any of the above, no error is thrown.\n"
136+
"\nResult:\n"
137+
" result (string) \"Debug mode: \" followed by the specified category.\n"
130138
"\nExamples:\n"
131139
+ HelpExampleCli("debug", "dash")
132140
+ HelpExampleRpc("debug", "dash+net")

0 commit comments

Comments
 (0)