main: add prune documentation to sample-btcd.conf (#2299)

btcsuite · Jan 2, 2025 · c2b47e0 · c2b47e0
1 parent b1b1e95
commit c2b47e0
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/sample-btcd.conf b/sample-btcd.conf
@@ -13,6 +13,12 @@
 ; $VARIABLE here.  Also, ~ is expanded to $LOCALAPPDATA on Windows.
 ; datadir=~/.btcd/data
 
+; The prune option removes old blocks from disk after they're downloaded and
+; verified.  The smallest value is 1536 which will limit the block data to 1536
+; mebibytes.
+; NOTE: This limit does not apply to indexes and the UTXO set which are both
+; larger than 1536 mebibytes as of December 2024.
+; prune=1536
 
 ; ------------------------------------------------------------------------------
 ; Network settings