Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

users/config: Improve modTimeWindowS explanation #584

Merged
merged 3 commits into from Feb 2, 2021
Merged

users/config: Improve modTimeWindowS explanation #584

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
780c8d8
users/config: Improve modTimeWindowS explanation (#582)
tomasz1986 Oct 30, 2020
127cb79
wip
tomasz1986 Jan 26, 2021
9424c4e
wip
tomasz1986 Feb 2, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 6 additions & 3 deletions users/config.rst
View file
Open in desktop
Expand Up @@ -354,9 +354,12 @@ copyOwnershipFromParent
Requires running Syncthing as privileged user, or granting it additional capabilities (e.g. CAP_CHOWN on Linux).

modTimeWindowS
Allowed modification timestamp difference when comparing files for equivalence.
To be used on systems that have unstable modification timestamps, that might change after being observed after
the last write operation. Used in Android only.
Allowed modification timestamp difference when comparing files for
equivalence. To be used on file systems which have unstable or
imprecise modification timestamps (e.g. FAT) that might change after
being recorded during the last write operation. Must be set before
adding files to the folder in order to take effect. Usually defaults
Copy link
Member

@calmh calmh Oct 30, 2020 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know the context of this addition, but I don't think "must be set before adding files to the folder to take effect" increases understanding much here... Any config change only affects what happens after it is made, obviously, but this somehow implies it won't work if set on an existing folder.

Perhaps something in the first sentence about the comparison being used to decide whether a file has changed and needs to be rehashed? Then it might be more clear that changing this option doesn't un-rehash and un-change the file...

Or perhaps this doesn't belong here at all but is an aspect of recv-only folders ("once a local change has been detected in will not become un-detected even if relevant config options change").

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I know that the sentence is vague. I could not come up with anything better.

What do you think about something like this?

Must be set before adding files to the folder in order to take effect on those files.

Otherwise I will try to think about how to rewrite the sentences to explain the point better.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't particularly like that either, because it makes it sound like the value is somehow locked in per file once we've seen it the first time... while in reality it simply applies each and every time we look at a file and consider the modification timestamp.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I reworded the explanation a little bit, and also removed the controversial line. I agree that it will be better to explain this behaviour with regards to RO folders in general rather than having separate explanations under each setting.

to 2 on Android, and always to 0 elsewhere.

maxConcurrentWrites
Maximum number of concurrent write operations while syncing. Defaults to 2. Increasing this might increase or
Expand Down