Skip to content

Commit 392dbd0

Browse files
committed
specs/bep, users/config: Update for changes to symlink handling
1 parent 6503374 commit 392dbd0

File tree

2 files changed

+9
-20
lines changed

2 files changed

+9
-20
lines changed

specs/bep-v1.rst

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -384,9 +384,9 @@ Protocol Buffer Schema
384384
enum FileInfoType {
385385
FILE = 0;
386386
DIRECTORY = 1;
387-
SYMLINK_FILE = 2;
388-
SYMLINK_DIRECTORY = 3;
389-
SYMLINK_UNKNOWN = 4;
387+
SYMLINK_FILE = 2 [deprecated = true];
388+
SYMLINK_DIRECTORY = 3 [deprecated = true];
389+
SYMLINK = 4;
390390
}
391391
392392
message BlockInfo {
@@ -422,11 +422,7 @@ operating system conventions. The combination of folder and name uniquely
422422
identifies each file in a cluster.
423423

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

431427
The **size** field contains the size of the file, in bytes. For directories
432428
and symlinks the size is zero.

users/config.rst

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,6 @@ The following shows an example of the default configuration file (IDs will diffe
102102
<keepTemporariesH>24</keepTemporariesH>
103103
<cacheIgnoredFiles>false</cacheIgnoredFiles>
104104
<progressUpdateIntervalS>5</progressUpdateIntervalS>
105-
<symlinksEnabled>true</symlinksEnabled>
106105
<limitBandwidthInLan>false</limitBandwidthInLan>
107106
<minHomeDiskFreePct>1</minHomeDiskFreePct>
108107
<releasesURL>https://api.github.com/repos/syncthing/syncthing/releases?per_page=30</releasesURL>
@@ -184,13 +183,13 @@ The following child elements may exist:
184183
device
185184
These must have the ``id`` attribute and can have an ``introducedBy`` attribute,
186185
identifying the device that introduced us to share this folder with the given device.
187-
If the original introducer unshares this folder with this device, our device will follow
186+
If the original introducer unshares this folder with this device, our device will follow
188187
and unshare the folder (subject to skipIntroductionRemovals being false on the introducer device).
189-
All mentioned devices are those that will be sharing the folder in question.
188+
All mentioned devices are those that will be sharing the folder in question.
190189
Each mentioned device must have a separate ``device`` element later in the file.
191190
It is customary that the local device ID is included in all folders.
192191
Syncthing will currently add this automatically if it is not present in
193-
the configuration file.
192+
the configuration file.
194193

195194
minDiskFreePct
196195
The percentage of space that should be available on the disk this folder
@@ -309,9 +308,9 @@ introducer
309308

310309
skipIntroductionRemovals
311310
Set to true if you wish to follow only introductions and not de-introductions.
312-
For example, if this is set, we would not remove a device that we were introduced
311+
For example, if this is set, we would not remove a device that we were introduced
313312
to even if the original introducer is no longer listing the remote device as known.
314-
313+
315314
introducedBy
316315
Defines which device has introduced us to this device. Used only for following de-introductions.
317316

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

556-
symlinksEnabled
557-
Whether to sync symlinks, if supported by the system. Symlinks are supported
558-
on all platforms except for Windows, where they are ignored. Syncthing does
559-
not differentiate between different types of symlinks.
560-
561554
limitBandwidthInLan
562555
Whether to apply bandwidth limits to devices in the same broadcast domain
563556
as the local device.

0 commit comments

Comments
 (0)