diff --git a/users/versioning.rst b/users/versioning.rst index 31cad450f..5bbdaba7c 100644 --- a/users/versioning.rst +++ b/users/versioning.rst @@ -1,9 +1,6 @@ File Versioning =============== -.. warning:: - This page may be out of date and requires review. - .. todo:: External versioning requires documenting. @@ -13,14 +10,6 @@ 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. -.. todo:: - More detail needed here: Can this be a relative path, or must it be - an absolute path? - -With "Staggered File Versioning" method (only), you would like to specify where -removed and deleted files are stored as part of the Versioning feature, you can -specify the path in the "Versions Path" input after this method is selected. - No File Versioning ------------------ @@ -33,30 +22,29 @@ replaced or deleted.) Simple File Versioning ---------------------- -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 you set this value to 5, if a file is -replaced 5 times on a remote device, you will see 5 time-stamped -versions on that file in the ".stversions" folder on the other devices -sharing the same 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 you -set this value to 5, if a file is replaced 5 times on a remote device, you will -see 5 time-stamped versions on that file in the ".stversions" folder on the -other devices sharing the same folder. +Syncthing how many old versions of the file it should keep. For example, if +you set this value to 5, if a file is replaced 5 times on a remote device, you +will see 5 time-stamped versions on that file in the ".stversions" folder on +the other devices sharing the same folder. Staggered File Versioning ------------------------- -With "Staggered File Versioning" files are also moved to the ".stversions" -folder (inside your shared folder) when replaced or deleted on a remote device -(just like "Simple File Versioning"), however, Version are automatically deleted -if they are older than the maximum age or exceed the number of files allowed in -an interval. +With "Staggered File Versioning" files are also moved to a different folder +when replaced or deleted on a remote device (just like "Simple File +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 +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 +relative path. Relative paths are interpreted relative to Syncthing's current +or startup directory. The following intervals are used and they each have a maximum number of files that will be kept for each.