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.
The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.
For details see: https://corecheck.dev/bitcoin/bitcoin/pulls/32333.
See the guideline for information on the review process.
| Type | Reviewers |
|---|---|
| ACK | maflcko, janb84, yancyribbens, achow101 |
If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.
LGTM
0pruneblockchain height
1
2Deletes block and undo data up to a specified height or timestamp.
3Requires `-prune` to be enabled at startup; this action is irreversible.
4
5Arguments:
61. height (numeric, required) The block height to prune up to. May be set to a discrete height, or to a UNIX epoch time
7 to prune blocks whose block time is at least 2 hours older than the provided timestamp.
8
9Result:
10n (numeric) Height of the last block pruned
11
12Examples:
13> bitcoin-cli pruneblockchain 1000
ACK fa5ed18
This PR adds some additional explanatory text (top level) to the pruneblockchain RPC help output. Provides more clarity what the command does and makes it more consistent with other help outputs.
New output :
0 % ./bitcoin-cli --regtest pruneblockchain
1error code: -1
2error message:
3pruneblockchain height
4
5Deletes block and undo data up to a specified height or timestamp.
6Requires `-prune` to be enabled at startup; this action is irreversible.
7
8Arguments:
91. height (numeric, required) The block height to prune up to. May be set to a discrete height, or to a UNIX epoch time
10 to prune blocks whose block time is at least 2 hours older than the provided timestamp.
11
12Result:
13n (numeric) Height of the last block pruned
14
15Examples:
16> bitcoin-cli pruneblockchain 1000
853@@ -854,7 +854,9 @@ std::optional<int> GetPruneHeight(const BlockManager& blockman, const CChain& ch
854
855 static RPCHelpMan pruneblockchain()
856 {
857- return RPCHelpMan{"pruneblockchain", "",
858+ return RPCHelpMan{"pruneblockchain",
859+ "\nDeletes block and undo data up to a specified height or timestamp.\n"
853@@ -854,7 +854,9 @@ std::optional<int> GetPruneHeight(const BlockManager& blockman, const CChain& ch
854
855 static RPCHelpMan pruneblockchain()
856 {
857- return RPCHelpMan{"pruneblockchain", "",
858+ return RPCHelpMan{"pruneblockchain",
859+ "\nDeletes block and undo data up to a specified height or timestamp.\n"
860+ "Requires `-prune` to be enabled at startup; this action is irreversible.\n",
getblockfrompeer can reverse it AFAIK
853@@ -854,7 +854,9 @@ std::optional<int> GetPruneHeight(const BlockManager& blockman, const CChain& ch
854
855 static RPCHelpMan pruneblockchain()
856 {
857- return RPCHelpMan{"pruneblockchain", "",
858+ return RPCHelpMan{"pruneblockchain",
859+ "\nAttempts to delete block and undo data up to a specified height or timestamp, if eligible for pruning.\n"
0 "Attempts to delete block and undo data up to a specified height or timestamp, if eligible for pruning.\n"
nit: No need to start with a newline. It will be trimmed anyway.
Thanks for the feedback :)
I’ve updated the description to clarify that pruning is conditional (not guaranteed), and that pruned data may be re-fetched in some cases (e.g., via getblockfrompeer). As such, the action is not strictly irreversible. Let me know if you’d like to see any further changes.
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.
cr ACK https://github.com/bitcoin/bitcoin/pull/32333/commits/135a0f0aa711b95c50aa4cbe0c38d82d647f1c8b
Nice, didn’t know this rpc existed.
