From c2b47e014983654c1326f8ae2525ba49bc9e0182 Mon Sep 17 00:00:00 2001
From: Calvin Kim <calvin@kcalvinalvin.info>
Date: Fri, 3 Jan 2025 00:20:37 +0900
Subject: [PATCH] main: add prune documentation to sample-btcd.conf (#2299)

---
 sample-btcd.conf | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/sample-btcd.conf b/sample-btcd.conf
index 74b20e1660..0fb688fbfc 100644
--- 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