Describe trash can versioning

syncthing · Jun 12, 2015 · 000536c · rumpelsepp · Jun 12, 2015 · 000536c
1 parent 86647d6
commit 000536c
Showing 1 changed file with 16 additions and 8 deletions.
diff --git a/users/versioning.rst b/users/versioning.rst
@@ -4,12 +4,6 @@ File Versioning
 .. todo::
     External versioning needs example for Windows.
 
-Description
------------
-
-There are 3 types of File Versioning. When you select each in the web interface,
-a short description of each is shown to help you decide.
-
 No File Versioning
 ------------------
 
@@ -19,10 +13,24 @@ with. (Note: If a folder is marked "Master Folder" on a device, that device will
 not accept changes to the files in the folder, and therefore will not have files
 replaced or deleted.)
 
+Trash Can File Versioning
+-------------------------
+
+This versioning strategy emulates the common "trash can" approach. When a file
+is deleted or replaced due to a change on a remote device, it is a moved to
+the trash can in the ``.stversions`` folder. If a file with the same name was
+already in the trash can it is replaced.
+
+A configuration option is available to clean the trash can from files older
+than a specified number of days. If this is set to a positive number of days,
+files will be removed when they have been in the trash can that long. Setting
+this to zero prevents any files from being removed from the trash can
+automatically.
+
 Simple File Versioning
 ----------------------
 
-With "Simple File Versioning" files are moved to the ".stversions" folder
+With "Simple File Versioning" files are moved to the ``.stversions`` folder
 (inside your shared folder) when replaced or deleted on a remote device. This
 option also takes a value in an input titled "Keep Versions" which tells
 Syncthing how many old versions of the file it should keep. For example, if
@@ -39,7 +47,7 @@ Versioning"), however, versions are automatically deleted if they are older
 than the maximum age or exceed the number of files allowed in an interval.
 
 With this versioning method it's possible to specify where the versions are
-stored, with the default being the `.stversions` folder inside the normal
+stored, with the default being the ``.stversions`` folder inside the normal
 folder path. If you set a custom version path, please ensure that it's on the
 same partition or filesystem as the regular folder path, as moving files there
 may otherwise fail. You can use an absolute path (this is recommended) or a