Browse Source

Add warning comment to getinfo

Warn that people should not add new information, or change current
information returned by getinfo.
0.10
Wladimir J. van der Laan 10 years ago
parent
commit
f9de17ec2f
No known key found for this signature in database
GPG Key ID: 74810B012346C9A6
  1. 13
      src/rpcmisc.cpp

13
src/rpcmisc.cpp

@ -27,6 +27,19 @@ using namespace boost::assign; @@ -27,6 +27,19 @@ using namespace boost::assign;
using namespace json_spirit;
using namespace std;
/**
* @note Do not add or change anything in the information returned by this
* method. `getinfo` exists for backwards-compatibilty only. It combines
* information from wildly different sources in the program, which is a mess,
* and is thus planned to be deprecated eventually.
*
* Based on the source of the information, new information should be added to:
* - `getblockchaininfo`,
* - `getnetworkinfo` or
* - `getwalletinfo`
*
* Or alternatively, create a specific query method for the information.
**/
Value getinfo(const Array& params, bool fHelp)
{
if (fHelp || params.size() != 0)

Loading…
Cancel
Save