From 84082dbca3f55e2870b0026fb8150d4dc7b05fbe Mon Sep 17 00:00:00 2001
From: tan jo <tanmayjoddar17@gmail.com>
Date: Thu, 15 May 2025 19:48:50 +0530
Subject: [PATCH] doc: clarify SPACE_LIMIT and FREE_LIMIT descriptions in man
 page (fixes #967)

---
 doc/snapper-configs.xml.in | 18 ++++++------------
 1 file changed, 6 insertions(+), 12 deletions(-)

diff --git a/doc/snapper-configs.xml.in b/doc/snapper-configs.xml.in
index 73379557..d9cc8439 100644
--- a/doc/snapper-configs.xml.in
+++ b/doc/snapper-configs.xml.in
@@ -60,29 +60,23 @@
 	</listitem>
       </varlistentry>
 
-      <varlistentry>
-	<term><option>SPACE_LIMIT=<replaceable>float</replaceable> or
+      <varlistentry>	<term><option>SPACE_LIMIT=<replaceable>float</replaceable> or
 	<replaceable>size</replaceable></option></term>
 	<listitem>
-	  <para>Limit of the filesystems space the snapshots should
-	  use. Either a fraction of the whole filesystem or an
-	  absolute value. An absolute value must use the C locale.</para>
+	  <para>Threshold for the maximum space snapshots should use on the filesystem. When snapshots exceed this limit (either as a fraction of the whole filesystem or an absolute value), snapper will remove older snapshots during cleanup operations. An absolute value must use the C locale.</para>
 	  <para>Only supported for btrfs.</para>
-	  <para>Default value is &quot;0.5&quot;.</para>
+	  <para>Default value is &quot;0.5&quot; (50% of the filesystem).</para>
 	  <para>New in version 0.3.0, absolute value new in version
 	  0.9.0.</para>
 	</listitem>
       </varlistentry>
 
-      <varlistentry>
-	<term><option>FREE_LIMIT=<replaceable>float</replaceable> or
+      <varlistentry>	<term><option>FREE_LIMIT=<replaceable>float</replaceable> or
 	<replaceable>size</replaceable></option></term>
 	<listitem>
-	  <para>Limit of the filesystem space that should be
-	  free. Either a fraction of the whole filesystem or an absolute
-	  value. An absolute value must use the C locale.</para>
+	  <para>Threshold for the minimum free space that should remain on the filesystem. When free space falls below this limit (either as a fraction of the whole filesystem or an absolute value), snapper will remove older snapshots during cleanup operations to reclaim space. An absolute value must use the C locale.</para>
 	  <para>Only supported for btrfs.</para>
-	  <para>Default value is &quot;0.2&quot;.</para>
+	  <para>Default value is &quot;0.2&quot; (20% of the filesystem).</para>
 	  <para>New in version 0.8.0, absolute value new in version 0.9.0.</para>
 	</listitem>
       </varlistentry>
-- 
2.47.3