From: Arvin Schnell <aschnell@suse.de>
Date: Tue, 22 Sep 2015 10:22:36 +0000 (+0200)
Subject: - added documentation
X-Git-Tag: v0.3.3~58^2~3
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=cdc69a14b7a7c9b842358beaa4ce962363cb496f;p=thirdparty%2Fsnapper.git

- added documentation
---

diff --git a/client/mksubvolume.cc b/client/mksubvolume.cc
index 16e41d25..51274123 100644
--- a/client/mksubvolume.cc
+++ b/client/mksubvolume.cc
@@ -258,6 +258,23 @@ find_filesystem(MntTable& mnt_table)
 }
 
 
+/*
+ * The used algorithm is as follow:
+ *
+ * 1. Search upwards from target for a filesystem (not mounted with subvol
+ *    option). The filesystem must of course be btrfs.
+ *
+ * 2. Determine the name for new subvolume: It is the target name without the
+ *    leading filesystem target (mountpoint).
+ *
+ * 3. Temporarily mount the filesystem and create new subvolume. Reasons for
+ *    the mount are documented in bsc #910602.
+ *
+ * 4. Create new subvolume.
+ *
+ * 5. Add new subvolume mount to fstab and mount new subvolume.
+ */
+
 void
 doit()
 {