highperfocused/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-08-03 22:33:43 +02:00
Code Issues Packages Projects Releases Wiki Activity

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 135a0f0aa7
1 changed files with 3 additions and 1 deletions
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",
"Attempts to delete block and undo data up to a specified height or timestamp, if eligible for pruning.\n"
"Requires `-prune` to be enabled at startup. While pruned data may be re-fetched in some cases (e.g., via `getblockfrompeer`), local deletion 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."},