feat: deprecate RPC 'debug' to favor of 'logging'

dashpay · Dec 11, 2024 · 9766cbe · 9766cbe
1 parent 6d97441
commit 9766cbe
Showing 1 changed file with 8 additions and 9 deletions.
diff --git a/src/rpc/misc.cpp b/src/rpc/misc.cpp
@@ -47,14 +47,10 @@
 static RPCHelpMan debug()
 {
     return RPCHelpMan{"debug",
-        "Change debug category on the fly. Specify single category or use '+' to specify many.\n"
-        "The valid logging categories are: " + LogInstance().LogCategoriesString() + ".\n"
-        "libevent logging is configured on startup and cannot be modified by this RPC during runtime.\n"
-        "There are also a few meta-categories:\n"
-        " - \"all\", \"1\" and \"\" activate all categories at once;\n"
-        " - \"dash\" activates all Dash-specific categories at once;\n"
-        " - \"none\" (or \"0\") deactivates all categories at once.\n"
-        "Note: If specified category doesn't match any of the above, no error is thrown.\n",
+        "DEPRECATED. Use instead the 'logging' RPC instead.\n"
+        "For 'debug all': logging [\\\"all\\\"]\n"
+        "For 'debug none': logging []\n"
+        "For 'debug X+Y': logging \"[\\\"X\\\", \\\"Y\\\"]\"",
         {
             {"category", RPCArg::Type::STR, RPCArg::Optional::NO, "The name of the debug category to turn on."},
         },
@@ -67,6 +63,9 @@ static RPCHelpMan debug()
         },
         [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
 {
+    if (!IsDeprecatedRPCEnabled("debug")) {
+        throw JSONRPCError(RPC_METHOD_DEPRECATED, "Please use logging instead");
+    }
 
     std::string strMode = request.params[0].get_str();
     LogInstance().DisableCategory(BCLog::ALL);
@@ -1512,7 +1511,6 @@ void RegisterMiscRPCCommands(CRPCTable &t)
 static const CRPCCommand commands[] =
 { //  category              actor (function)
   //  --------------------- ------------------------
-    { "control",            &debug,                   },
     { "control",            &getmemoryinfo,           },
     { "control",            &logging,                 },
     { "util",               &validateaddress,         },
@@ -1537,6 +1535,7 @@ static const CRPCCommand commands[] =
     { "dash",               &sporkupdate,             },
 
     /* Not shown in help */
+    { "hidden",             &debug,                   },
     { "hidden",             &setmocktime,             },
     { "hidden",             &mockscheduler,           },
     { "hidden",             &echo,                    },