TrueCloudLab/rclone
16
0
Fork 4
Code Issues 3 Pull requests 2 Projects Releases 3 Packages Wiki Activity Actions

docs: clarify --update and --use-server-mod-time

Browse source 
It's likely a mistake to use `--use-server-modtime` if you're not also using `--update`. It might even make sense to emit a warning in the code when doing this, but for now, I made it more clear in the docs.

I also clarified how `--use-server-modtime` can be useful in the `--update` section.
This commit is contained in:
Russell Davis 2019-07-02 02:09:03 -07:00 • committed by Nick Craig-Wood
parent 5df5a3b78e
commit ea35e807db
1 changed files with 16 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
docs/content/docs.md
View file

@ -1060,15 +1060,16 @@ If an existing destination file has a modification time equal (within
the computed modify window precision) to the source file's, it will be the computed modify window precision) to the source file's, it will be
updated if the sizes are different. updated if the sizes are different.
On remotes which don't support mod time directly the time checked will On remotes which don't support mod time directly (or when using
be the uploaded time. This means that if uploading to one of these `--use-server-mod-time`) the time checked will be the uploaded time.
remotes, rclone will skip any files which exist on the destination and This means that if uploading to one of these remotes, rclone will skip
have an uploaded time that is newer than the modification time of the any files which exist on the destination and have an uploaded time that
source file. is newer than the modification time of the source file.
This can be useful when transferring to a remote which doesn't support This can be useful when transferring to a remote which doesn't support
mod times directly as it is more accurate than a `--size-only` check mod times directly (or when using `--use-server-mod-time` to avoid extra
and faster than using `--checksum`. API calls) as it is more accurate than a `--size-only` check and faster
than using `--checksum`.
### --use-mmap ### ### --use-mmap ###
@ -1093,10 +1094,14 @@ additional metadata on the object. By default it will make an API call to
retrieve the metadata when the modtime is needed by an operation. retrieve the metadata when the modtime is needed by an operation.
Use this flag to disable the extra API call and rely instead on the server's Use this flag to disable the extra API call and rely instead on the server's
modified time. In cases such as a local to remote sync, knowing the local file modified time. In cases such as a local to remote sync using `--update`,
is newer than the time it was last uploaded to the remote is sufficient. In knowing the local file is newer than the time it was last uploaded to the
those cases, this flag can speed up the process and reduce the number of API remote is sufficient. In those cases, this flag can speed up the process and
calls necessary. reduce the number of API calls necessary.
Using this flag on a sync operation without also using `--update` would cause
all files modified at any time other than the last upload time to be uploaded
again, which is probably not what you want.
### -v, -vv, --verbose ### ### -v, -vv, --verbose ###