Skip to content

Commit

Permalink
specs/bep, users/config: Update for changes to symlink handling
Browse files Browse the repository at this point in the history
  • Loading branch information
calmh committed Feb 7, 2017
1 parent 6503374 commit 392dbd0
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 20 deletions.
12 changes: 4 additions & 8 deletions specs/bep-v1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -384,9 +384,9 @@ Protocol Buffer Schema
enum FileInfoType {
FILE = 0;
DIRECTORY = 1;
SYMLINK_FILE = 2;
SYMLINK_DIRECTORY = 3;
SYMLINK_UNKNOWN = 4;
SYMLINK_FILE = 2 [deprecated = true];
SYMLINK_DIRECTORY = 3 [deprecated = true];
SYMLINK = 4;
}
message BlockInfo {
Expand Down Expand Up @@ -422,11 +422,7 @@ operating system conventions. The combination of folder and name uniquely
identifies each file in a cluster.

The **type** field contains the type of the described item. The type is one
of **file (0)**, **directory (1)**, **symlink to file (2)**, **symlink to
directory (3)**, or **symlink to unknown target (4)**. The distinction
between the various types of symlinks is not required on all operating
systems - the implementation SHOULD nonetheless indicate the target type
when possible.
of **file (0)**, **directory (1)**, or **symlink (4)**.

The **size** field contains the size of the file, in bytes. For directories
and symlinks the size is zero.
Expand Down
17 changes: 5 additions & 12 deletions users/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,6 @@ The following shows an example of the default configuration file (IDs will diffe
<keepTemporariesH>24</keepTemporariesH>
<cacheIgnoredFiles>false</cacheIgnoredFiles>
<progressUpdateIntervalS>5</progressUpdateIntervalS>
<symlinksEnabled>true</symlinksEnabled>
<limitBandwidthInLan>false</limitBandwidthInLan>
<minHomeDiskFreePct>1</minHomeDiskFreePct>
<releasesURL>https://api.github.com/repos/syncthing/syncthing/releases?per_page=30</releasesURL>
Expand Down Expand Up @@ -184,13 +183,13 @@ The following child elements may exist:
device
These must have the ``id`` attribute and can have an ``introducedBy`` attribute,
identifying the device that introduced us to share this folder with the given device.
If the original introducer unshares this folder with this device, our device will follow
If the original introducer unshares this folder with this device, our device will follow
and unshare the folder (subject to skipIntroductionRemovals being false on the introducer device).
All mentioned devices are those that will be sharing the folder in question.
All mentioned devices are those that will be sharing the folder in question.
Each mentioned device must have a separate ``device`` element later in the file.
It is customary that the local device ID is included in all folders.
Syncthing will currently add this automatically if it is not present in
the configuration file.
the configuration file.

minDiskFreePct
The percentage of space that should be available on the disk this folder
Expand Down Expand Up @@ -309,9 +308,9 @@ introducer

skipIntroductionRemovals
Set to true if you wish to follow only introductions and not de-introductions.
For example, if this is set, we would not remove a device that we were introduced
For example, if this is set, we would not remove a device that we were introduced
to even if the original introducer is no longer listing the remote device as known.

introducedBy
Defines which device has introduced us to this device. Used only for following de-introductions.

Expand Down Expand Up @@ -436,7 +435,6 @@ Options Element
<keepTemporariesH>24</keepTemporariesH>
<cacheIgnoredFiles>false</cacheIgnoredFiles>
<progressUpdateIntervalS>5</progressUpdateIntervalS>
<symlinksEnabled>true</symlinksEnabled>
<limitBandwidthInLan>false</limitBandwidthInLan>
<minHomeDiskFreePct>1</minHomeDiskFreePct>
<releasesURL>https://api.github.com/repos/syncthing/syncthing/releases?per_page=30</releasesURL>
Expand Down Expand Up @@ -553,11 +551,6 @@ progressUpdateIntervalS
How often in seconds the progress of ongoing downloads is made available to
the GUI.

symlinksEnabled
Whether to sync symlinks, if supported by the system. Symlinks are supported
on all platforms except for Windows, where they are ignored. Syncthing does
not differentiate between different types of symlinks.

limitBandwidthInLan
Whether to apply bandwidth limits to devices in the same broadcast domain
as the local device.
Expand Down

0 comments on commit 392dbd0

Please sign in to comment.