users/config: Improve modTimeWindowS explanation #584
Conversation
Reword the explanation to make it more specific. Add an example of a file system (FAT), where the setting is applicable. Add a warning about the necessecity of setting the value before adding files to the folder. Explicitly mention the default values depending on the OS. Signed-off-by: Tomasz Wilczyński <twilczynski@naver.com>
users/config.rst
Outdated
| 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 |
There was a problem hiding this comment.
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").
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
users/config.rst
Outdated
| equivalence. To be used on file systems which have unstable or | ||
| imprecise modification timestamps that might change after being |
There was a problem hiding this comment.
Imprecise timestamps are not a problem, only unstable ones. For an attempted explanation see: https://forum.syncthing.net/t/why-default-modtimewindows-to-2-for-fat-only-on-android/16256/2
|
Why is there the "(#582)" in the commit message? I don't see the connection. |
tomasz1986
changed the title
There is no connection, just a mistake on my part. Fixed! |
* main: (21 commits) Remove dead Badger experiment users/config: Describe QUIC address config (#618) Mention QUIC related port (#617) dev/release-creation: Adjust to changes to grt tool dev/building: Update go version to 1.16 (#614) dev/building: Add Windows and Android prerequisite information (#615) Update versioning.rst (#613) users/config: Add a warning to ignoreDelete (#608) users/versioning: Improve external versioning example script for Windows (#606) gui: Make terms bold in definition lists for better visibility (#609) dev/rest: Update db/browse example dev/release-creation: Create new milestone users/config: Use backslashes for Windows paths (#603) users/config: Improve modTimeWindowS explanation (#584) users/foldertypes: Button wording (#602) events: Add PendingDevicesChanged and PendingFoldersChanged (ref #592) (#597) users/config: Document decoupled database + config (fixes #571) (#600) users/stdiscosrv, users/strelaysrv: Better documentation how to obtain the binaries. (#601) advanced/folder-ignoredelete: Add a warning about using ignoreDelete (#598) rest: API for pending devices and folders. (#498) ...
Reword the explanation to make it more specific. Add an example of a
file system (FAT), where the setting is applicable. Add a warning about
the necessecity of setting the value before adding files to the folder.
Explicitly mention the default values depending on the OS.
Signed-off-by: Tomasz Wilczyński twilczynski@naver.com