From: Arvin Schnell <aschnell@suse.de>
Date: Mon, 16 Dec 2024 07:52:38 +0000 (+0100)
Subject: - improved documentation
X-Git-Tag: v0.12.1~14^2
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F968%2Fhead;p=thirdparty%2Fsnapper.git

- improved documentation
---

diff --git a/client/snbk/TheBigThing.cc b/client/snbk/TheBigThing.cc
index c823c621..af7046f0 100644
--- a/client/snbk/TheBigThing.cc
+++ b/client/snbk/TheBigThing.cc
@@ -230,7 +230,12 @@ namespace snapper
 	: snapper(snappers->getSnapper(backup_config.config)), locker(snapper)
     {
 	if (backup_config.source_path != snapper->getConfig().getSubvolume())
-	    SN_THROW(Exception(_("Path mismatch between backup-config and config.")));
+	{
+	    string error = sformat(_("Path mismatch between source-path of backup-config and subvolume of "
+				     "snapper config ('%s' vs. '%s')."), backup_config.source_path.c_str(),
+				   snapper->getConfig().getSubvolume().c_str());
+	    SN_THROW(Exception(error));
+	}
 
 	probe_source(backup_config, verbose);
 	probe_target(backup_config, verbose);
diff --git a/doc/snapper-backup-configs.xml.in b/doc/snapper-backup-configs.xml.in
index 49f6ab4e..88283595 100644
--- a/doc/snapper-backup-configs.xml.in
+++ b/doc/snapper-backup-configs.xml.in
@@ -50,14 +50,15 @@
       <varlistentry>
 	<term><option>source-path</option></term>
 	<listitem>
-	  <para>Path of the subvolume or mount point.</para>
+	  <para>Path of the source subvolume. This must match the
+	  subvolume of the corresponding snapper config.</para>
 	</listitem>
       </varlistentry>
 
       <varlistentry>
 	<term><option>target-path</option></term>
 	<listitem>
-	  <para>Path of the subvolume or mount point.</para>
+	  <para>Path of the target subvolume or mount point.</para>
 	</listitem>
       </varlistentry>