Skip to content

Commit 8785569

Browse files
committed
Merge bitcoin/bitcoin#32333: doc: Add missing top-level description to pruneblockchain RPC
135a0f0 doc: Add missing top-level description to pruneblockchain RPC (nervana21) Pull request description: 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 top-level description, improving documentation consistency and alerting users to the potential impacts of using the command. ACKs for top commit: maflcko: lgtm ACK 135a0f0 yancyribbens: cr ACK bitcoin/bitcoin@135a0f0 achow101: ACK 135a0f0 janb84: re ACK [135a0f0](bitcoin/bitcoin@135a0f0) Tree-SHA512: e51475238e779555315668b7389ed312a5d2c4ad1c0b251f2314895ac473092fa458b6f931f70385e14047adb7e340e44fe2198643603da9e129f1c874578a28
2 parents fad009a + 135a0f0 commit 8785569

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

src/rpc/blockchain.cpp

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -864,7 +864,9 @@ std::optional<int> GetPruneHeight(const BlockManager& blockman, const CChain& ch
864864

865865
static RPCHelpMan pruneblockchain()
866866
{
867-
return RPCHelpMan{"pruneblockchain", "",
867+
return RPCHelpMan{"pruneblockchain",
868+
"Attempts to delete block and undo data up to a specified height or timestamp, if eligible for pruning.\n"
869+
"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",
868870
{
869871
{"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"
870872
" to prune blocks whose block time is at least 2 hours older than the provided timestamp."},

0 commit comments

Comments
 (0)