From c0820c8a0c7fba740aca0a6403fc528f1b856a64 Mon Sep 17 00:00:00 2001 From: Jakob Borg Date: Thu, 24 Mar 2016 16:46:50 +0100 Subject: [PATCH] Delete followsymlinks.rst For now, as it causes endless confusion. --- draft/followsymlinks.rst | 72 ---------------------------------------- 1 file changed, 72 deletions(-) delete mode 100644 draft/followsymlinks.rst diff --git a/draft/followsymlinks.rst b/draft/followsymlinks.rst deleted file mode 100644 index 3c3952e7e..000000000 --- a/draft/followsymlinks.rst +++ /dev/null @@ -1,72 +0,0 @@ -.. note:: This describes an incomplete feature under development. - -.. warning:: - - This is an advanced feature. Be sure to read and fully understand this - guide, and have a backup of your data. Incorrect configuration may result in - the deletion of your files. Currently it's probably best to only use - ``FollowSymlinks`` on a folder master. - -Symbolic Link Following -======================= - -It is possible to synchronize directory trees not present directly under a -sync folder by using symbolic links ("symlinks") and enabling "following" of -them. This feature is currently experimental and cannot be enabled by using -the graphical interface. - -Operation ---------- - -When a folder is configured to follow symlinks, any such links that are -encountered during scanning will be resolved to their destination and scanned. -Symlinks can point to either files or directories. When symlink following is -enabled, the behavior is changed from the default (copy symlinks verbatim) to -the following: - -#. Symlinks pointing to a nonexistent destination are ignored. - -#. Symlinks pointing to a file are interpreted as being that file. - -#. Editing such a file on another device results in the *symlink* being - replaced with the new version of the file. - -#. Deleting such a file on another device results in the *symlink* being - deleted. - -#. Symlinks pointing to directories are interpreted as being that directory. - -#. Symlinks pointing to a directory that is a child of another already scanned - directory are ignored. This is to avoid infinite recursion in symlink - following. - -Enabling --------- - -.. code-block:: xml - - - - ... - true - - ... - - -Disabling ---------- - -.. warning:: - - Disabling ``FollowSymlinks``, once enabled, is not fully supported. Doing so - by the same mechanism used to enable it is likely to destroy your files. - -Disabling ``FollowSymlinks`` is inherently unsafe as it generates delete -records for all files that were previously accessible via the symlink. Under -some conditions, these files may be deleted from the reconfigured device -having the symlink, in addition to the other devices. - -The safest course of action is to remove the symlinks themselves, then disable -``FollowSymlinks``. The files previously reachable via the symlink will be -deleted from other devices, but (given the symlink was removed) are not -reachable and hence are preserved on the source device.