dup, rdiff: implemented and documented simpler and clearer symlinks/globbing

behaviour, as proposed on
http://lists.riseup.net/www/arc/backupninja/2006-07/msg00008.html

1 files changed, 15 insertions, 5 deletions

diff --git a/handlers/rdiff.helper b/handlers/rdiff.helper
index 904ac98..42bcb1b 100644
--- a/handlers/rdiff.helper
+++ b/handlers/rdiff.helper
@@ -271,12 +271,22 @@ type = local
 keep = $rdiff_keep
 
 # A few notes about includes and excludes:
-#   - include, exclude and vsinclude statements support EITHER globbing with '*'
-#     OR symlinks in the path; usage of both in the same statement is *not*
-#     supported and will lead to weird behaviour.
-#   - All the excludes come after all the includes. The order is not otherwise
-#     taken into account.
+# 1. include, exclude and vsinclude statements support globbing with '*'
+# 2. Symlinks are not dereferenced. Moreover, an include line whose path
+#    contains, at any level, a symlink to a directory, will only have the
+#    symlink backed-up, not the target directory's content. Yes, you have to
+#    dereference yourself the symlinks, or to use 'mount --bind' instead.
+#    Example: let's say /home is a symlink to /mnt/crypt/home ; the following
+#    line will only backup a "/home" symlink ; neither /home/user nor
+#    /home/user/Mail will be backed-up :
+#      include = /home/user/Mail
+#    A workaround is to 'mount --bind /mnt/crypt/home /home' ; another one is to
+#    write :
+#      include = /mnt/crypt/home/user/Mail
+# 3. All the excludes come after all the includes. The order is not otherwise
+#    taken into account.
 
+# files to include in the backup
 EOF
    ## includes ##
    if [ "$host_or_vservers" == host -o "$host_or_vservers" == both ]; then