Merge #14008: Preserve a format of RPC command definitions

laanwj · laanwj · commit 838b85e120fd · 2018-09-10T18:14:05.000+02:00
d9d7957 Preserve a format of RPC command definitions (Kostiantyn Stepaniuk) Pull request description: Currently, RPC commands are formatted in a way that it's easy to read and that `test/lint/check-rpc-mappings.py` can parse it. To void breaking `test/lint/check-rpc-mappings.py` script by running `clang-format`, RPC command definitions should be disabled for clang-format. Tree-SHA512: e17d20ec0e6c4e19410198b55687ebbe6fa01654d214d4578cd16c00b872bf8b0b306594a45523685cd2e9d9280702e00471d9366e87954428e8bbeacd8cad60
diff --git a/src/coins.h b/src/coins.h
@@ -285,8 +285,8 @@ class CCoinsViewCache : public CCoinsViewBacked
      * Note that lightweight clients may not know anything besides the hash of previous transactions,
      * so may not be able to calculate this.
      *
-     * @param[in] tx	transaction for which we are checking input total
-     * @return	Sum of value of all inputs (scriptSigs)
+     * @param[in] tx    transaction for which we are checking input total
+     * @return  Sum of value of all inputs (scriptSigs)
      */
     CAmount GetValueIn(const CTransaction& tx) const;
 
diff --git a/src/rpc/blockchain.cpp b/src/rpc/blockchain.cpp
@@ -2192,6 +2192,7 @@ UniValue scantxoutset(const JSONRPCRequest& request)
     return result;
 }
 
+// clang-format off
 static const CRPCCommand commands[] =
 { //  category              name                      actor (function)         argNames
   //  --------------------- ------------------------  -----------------------  ----------
@@ -2227,6 +2228,7 @@ static const CRPCCommand commands[] =
     { "hidden",             "waitforblockheight",     &waitforblockheight,     {"height","timeout"} },
     { "hidden",             "syncwithvalidationinterfacequeue", &syncwithvalidationinterfacequeue, {} },
 };
+// clang-format on
 
 void RegisterBlockchainRPCCommands(CRPCTable &t)
 {
diff --git a/src/rpc/client.cpp b/src/rpc/client.cpp
@@ -18,6 +18,7 @@ class CRPCConvertParam
     std::string paramName;  //!< parameter name
 };
 
+// clang-format off
 /**
  * Specify a (method, idx, name) here if the argument is a non-string RPC
  * argument and needs to be converted from JSON.
@@ -163,6 +164,7 @@ static const CRPCConvertParam vRPCConvertParams[] =
     { "rescanblockchain", 1, "stop_height"},
     { "createwallet", 1, "disable_private_keys"},
 };
+// clang-format on
 
 class CRPCConvertTable
 {
diff --git a/src/rpc/mining.cpp b/src/rpc/mining.cpp
@@ -968,6 +968,7 @@ static UniValue estimaterawfee(const JSONRPCRequest& request)
     return result;
 }
 
+// clang-format off
 static const CRPCCommand commands[] =
 { //  category              name                      actor (function)         argNames
   //  --------------------- ------------------------  -----------------------  ----------
@@ -986,6 +987,7 @@ static const CRPCCommand commands[] =
 
     { "hidden",             "estimaterawfee",         &estimaterawfee,         {"conf_target", "threshold"} },
 };
+// clang-format on
 
 void RegisterMiningRPCCommands(CRPCTable &t)
 {
diff --git a/src/rpc/misc.cpp b/src/rpc/misc.cpp
@@ -439,6 +439,7 @@ static UniValue echo(const JSONRPCRequest& request)
     return request.params;
 }
 
+// clang-format off
 static const CRPCCommand commands[] =
 { //  category              name                      actor (function)         argNames
   //  --------------------- ------------------------  -----------------------  ----------
@@ -454,6 +455,7 @@ static const CRPCCommand commands[] =
     { "hidden",             "echo",                   &echo,                   {"arg0","arg1","arg2","arg3","arg4","arg5","arg6","arg7","arg8","arg9"}},
     { "hidden",             "echojson",               &echo,                   {"arg0","arg1","arg2","arg3","arg4","arg5","arg6","arg7","arg8","arg9"}},
 };
+// clang-format on
 
 void RegisterMiscRPCCommands(CRPCTable &t)
 {
diff --git a/src/rpc/net.cpp b/src/rpc/net.cpp
@@ -626,6 +626,7 @@ static UniValue setnetworkactive(const JSONRPCRequest& request)
     return g_connman->GetNetworkActive();
 }
 
+// clang-format off
 static const CRPCCommand commands[] =
 { //  category              name                      actor (function)         argNames
   //  --------------------- ------------------------  -----------------------  ----------
@@ -642,6 +643,7 @@ static const CRPCCommand commands[] =
     { "network",            "clearbanned",            &clearbanned,            {} },
     { "network",            "setnetworkactive",       &setnetworkactive,       {"state"} },
 };
+// clang-format on
 
 void RegisterNetRPCCommands(CRPCTable &t)
 {
diff --git a/src/rpc/rawtransaction.cpp b/src/rpc/rawtransaction.cpp
@@ -1695,6 +1695,7 @@ UniValue converttopsbt(const JSONRPCRequest& request)
     return EncodeBase64((unsigned char*)ssTx.data(), ssTx.size());
 }
 
+// clang-format off
 static const CRPCCommand commands[] =
 { //  category              name                            actor (function)            argNames
   //  --------------------- ------------------------        -----------------------     ----------
@@ -1716,6 +1717,7 @@ static const CRPCCommand commands[] =
     { "blockchain",         "gettxoutproof",                &gettxoutproof,             {"txids", "blockhash"} },
     { "blockchain",         "verifytxoutproof",             &verifytxoutproof,          {"proof"} },
 };
+// clang-format on
 
 void RegisterRawTransactionRPCCommands(CRPCTable &t)
 {
diff --git a/src/rpc/server.cpp b/src/rpc/server.cpp
@@ -252,6 +252,7 @@ static UniValue uptime(const JSONRPCRequest& jsonRequest)
     return GetTime() - GetStartupTime();
 }
 
+// clang-format off
 /**
  * Call Table
  */
@@ -263,6 +264,7 @@ static const CRPCCommand vRPCCommands[] =
     { "control",            "stop",                   &stop,                   {}  },
     { "control",            "uptime",                 &uptime,                 {}  },
 };
+// clang-format on
 
 CRPCTable::CRPCTable()
 {
diff --git a/src/wallet/rpcwallet.cpp b/src/wallet/rpcwallet.cpp
@@ -4065,6 +4065,7 @@ UniValue importprunedfunds(const JSONRPCRequest& request);
 UniValue removeprunedfunds(const JSONRPCRequest& request);
 UniValue importmulti(const JSONRPCRequest& request);
 
+// clang-format off
 static const CRPCCommand commands[] =
 { //  category              name                                actor (function)                argNames
     //  --------------------- ------------------------          -----------------------         ----------
@@ -4125,6 +4126,7 @@ static const CRPCCommand commands[] =
     { "wallet",             "walletpassphrasechange",           &walletpassphrasechange,        {"oldpassphrase","newpassphrase"} },
     { "wallet",             "walletprocesspsbt",                &walletprocesspsbt,             {"psbt","sign","sighashtype","bip32derivs"} },
 };
+// clang-format on
 
 void RegisterWalletRPCCommands(CRPCTable &t)
 {

Original file line number	Diff line number	Diff line change
`@@ -2192,6 +2192,7 @@ UniValue scantxoutset(const JSONRPCRequest& request)`
`2192`	`2192`	`return result;`
`2193`	`2193`	`}`
`2194`	`2194`
	`2195`	`+// clang-format off`
`2195`	`2196`	`static const CRPCCommand commands[] =`
`2196`	`2197`	`{ // category name actor (function) argNames`
`2197`	`2198`	`// --------------------- ------------------------ ----------------------- ----------`
`@@ -2227,6 +2228,7 @@ static const CRPCCommand commands[] =`
`2227`	`2228`	`{ "hidden", "waitforblockheight", &waitforblockheight, {"height","timeout"} },`
`2228`	`2229`	`{ "hidden", "syncwithvalidationinterfacequeue", &syncwithvalidationinterfacequeue, {} },`
`2229`	`2230`	`};`
	`2231`	`+// clang-format on`
`2230`	`2232`
`2231`	`2233`	`void RegisterBlockchainRPCCommands(CRPCTable &t)`
`2232`	`2234`	`{`
Original file line number	Diff line number	Diff line change
`@@ -968,6 +968,7 @@ static UniValue estimaterawfee(const JSONRPCRequest& request)`
`968`	`968`	`return result;`
`969`	`969`	`}`
`970`	`970`
	`971`	`+// clang-format off`
`971`	`972`	`static const CRPCCommand commands[] =`
`972`	`973`	`{ // category name actor (function) argNames`
`973`	`974`	`// --------------------- ------------------------ ----------------------- ----------`
`@@ -986,6 +987,7 @@ static const CRPCCommand commands[] =`
`986`	`987`
`987`	`988`	`{ "hidden", "estimaterawfee", &estimaterawfee, {"conf_target", "threshold"} },`
`988`	`989`	`};`
	`990`	`+// clang-format on`
`989`	`991`
`990`	`992`	`void RegisterMiningRPCCommands(CRPCTable &t)`
`991`	`993`	`{`
Original file line number	Diff line number	Diff line change
`@@ -439,6 +439,7 @@ static UniValue echo(const JSONRPCRequest& request)`
`439`	`439`	`return request.params;`
`440`	`440`	`}`
`441`	`441`
	`442`	`+// clang-format off`
`442`	`443`	`static const CRPCCommand commands[] =`
`443`	`444`	`{ // category name actor (function) argNames`
`444`	`445`	`// --------------------- ------------------------ ----------------------- ----------`
`@@ -454,6 +455,7 @@ static const CRPCCommand commands[] =`
`454`	`455`	`{ "hidden", "echo", &echo, {"arg0","arg1","arg2","arg3","arg4","arg5","arg6","arg7","arg8","arg9"}},`
`455`	`456`	`{ "hidden", "echojson", &echo, {"arg0","arg1","arg2","arg3","arg4","arg5","arg6","arg7","arg8","arg9"}},`
`456`	`457`	`};`
	`458`	`+// clang-format on`
`457`	`459`
`458`	`460`	`void RegisterMiscRPCCommands(CRPCTable &t)`
`459`	`461`	`{`
Original file line number	Diff line number	Diff line change
`@@ -626,6 +626,7 @@ static UniValue setnetworkactive(const JSONRPCRequest& request)`
`626`	`626`	`return g_connman->GetNetworkActive();`
`627`	`627`	`}`
`628`	`628`
	`629`	`+// clang-format off`
`629`	`630`	`static const CRPCCommand commands[] =`
`630`	`631`	`{ // category name actor (function) argNames`
`631`	`632`	`// --------------------- ------------------------ ----------------------- ----------`
`@@ -642,6 +643,7 @@ static const CRPCCommand commands[] =`
`642`	`643`	`{ "network", "clearbanned", &clearbanned, {} },`
`643`	`644`	`{ "network", "setnetworkactive", &setnetworkactive, {"state"} },`
`644`	`645`	`};`
	`646`	`+// clang-format on`
`645`	`647`
`646`	`648`	`void RegisterNetRPCCommands(CRPCTable &t)`
`647`	`649`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1695,6 +1695,7 @@ UniValue converttopsbt(const JSONRPCRequest& request)`
`1695`	`1695`	`return EncodeBase64((unsigned char*)ssTx.data(), ssTx.size());`
`1696`	`1696`	`}`
`1697`	`1697`
	`1698`	`+// clang-format off`
`1698`	`1699`	`static const CRPCCommand commands[] =`
`1699`	`1700`	`{ // category name actor (function) argNames`
`1700`	`1701`	`// --------------------- ------------------------ ----------------------- ----------`
`@@ -1716,6 +1717,7 @@ static const CRPCCommand commands[] =`
`1716`	`1717`	`{ "blockchain", "gettxoutproof", &gettxoutproof, {"txids", "blockhash"} },`
`1717`	`1718`	`{ "blockchain", "verifytxoutproof", &verifytxoutproof, {"proof"} },`
`1718`	`1719`	`};`
	`1720`	`+// clang-format on`
`1719`	`1721`
`1720`	`1722`	`void RegisterRawTransactionRPCCommands(CRPCTable &t)`
`1721`	`1723`	`{`
Original file line number	Diff line number	Diff line change
`@@ -252,6 +252,7 @@ static UniValue uptime(const JSONRPCRequest& jsonRequest)`
`252`	`252`	`return GetTime() - GetStartupTime();`
`253`	`253`	`}`
`254`	`254`
	`255`	`+// clang-format off`
`255`	`256`	`/**`
`256`	`257`	`* Call Table`
`257`	`258`	`*/`
`@@ -263,6 +264,7 @@ static const CRPCCommand vRPCCommands[] =`
`263`	`264`	`{ "control", "stop", &stop, {} },`
`264`	`265`	`{ "control", "uptime", &uptime, {} },`
`265`	`266`	`};`
	`267`	`+// clang-format on`
`266`	`268`
`267`	`269`	`CRPCTable::CRPCTable()`
`268`	`270`	`{`