phantom/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-04-29 14:59:39 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

doc: Add missing top-level description to pruneblockchain RPC

Browse source 
Previously, the `pruneblockchain` RPC help output included only the method signature and arguments, with no top-level description explaining its purpose or constraints.

This PR adds a concise top-level description, improving documentation consistency and alerting users to the potential impacts of using the command.
This commit is contained in:
nervana21 2025-04-27 22:06:40 -04:00
parent 9efe546688
commit fa5ed18946
No known key found for this signature in database
GPG key ID: 4B2D601F1E63068E
1 changed files with 3 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
src/rpc/blockchain.cpp
View file

@ -854,7 +854,9 @@ std::optional<int> GetPruneHeight(const BlockManager& blockman, const CChain& ch
static RPCHelpMan pruneblockchain()
{
return RPCHelpMan{"pruneblockchain", "",
return RPCHelpMan{"pruneblockchain",
"\nDeletes block and undo data up to a specified height or timestamp.\n"
"Requires `-prune` to be enabled at startup; this action is irreversible.\n",
{
{"height", RPCArg::Type::NUM, RPCArg::Optional::NO, "The block height to prune up to. May be set to a discrete height, or to a " + UNIX_EPOCH_TIME + "\n"
" to prune blocks whose block time is at least 2 hours older than the provided timestamp."},