jgaunt/rclone
1
0
Fork 0
mirror of https://github.com/rclone/rclone.git synced 2025-12-16 08:13:29 +00:00
Code Issues Projects Releases Wiki Activity

docs: change use of parameter type N and NUMBER to int consistent with flags and cli help

Browse Source
This commit is contained in:
albertony
2025-01-17 12:57:00 +01:00
parent 7f3f1af541
commit 3c092cfc17
3 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
cmd/check/check.go
View File

@@ -73,7 +73,7 @@ you what happened to it. These are reminiscent of diff files.
- |* path| means path was present in source and destination but different. - |* path| means path was present in source and destination but different.
- |! path| means there was an error reading or hashing the source or dest. - |! path| means there was an error reading or hashing the source or dest.
The default number of parallel checks is 8. See the [--checkers=N](/docs/#checkers-n) The default number of parallel checks is 8. See the [--checkers](/docs/#checkers-int)
option for more information. option for more information.
`, "|", "`") `, "|", "`")

20
docs/content/docs.md
View File

@@ -875,7 +875,7 @@ Using this flag can use more memory as it effectively sets
`--max-backlog` to infinite. This means that all the info on the `--max-backlog` to infinite. This means that all the info on the
objects to transfer is held in memory before the transfers start. objects to transfer is held in memory before the transfers start.
### --checkers=N ### --checkers=int
Originally controlling just the number of file checkers to run in parallel, Originally controlling just the number of file checkers to run in parallel,
e.g. by `rclone copy`. Now a fairly universal parallelism control e.g. by `rclone copy`. Now a fairly universal parallelism control
@@ -1462,7 +1462,7 @@ backends and the VFS. There are individual flags for just enabling it
for the VFS `--vfs-links` and the local backend `--local-links` if for the VFS `--vfs-links` and the local backend `--local-links` if
required. required.
### --list-cutoff N {#list-cutoff} ### --list-cutoff int {#list-cutoff}
When syncing rclone needs to sort directory entries before comparing When syncing rclone needs to sort directory entries before comparing
them. Below this threshold (1,000,000) by default, rclone will store them. Below this threshold (1,000,000) by default, rclone will store
@@ -1614,7 +1614,7 @@ returned from the rc call [core/stats](/rc/#core-stats).
### --low-level-retries NUMBER ### --low-level-retries=int
This controls the number of low level retries rclone does. This controls the number of low level retries rclone does.
@@ -1630,7 +1630,7 @@ to reduce the value so rclone moves on to a high level retry (see the
Disable low level retries with `--low-level-retries 1`. Disable low level retries with `--low-level-retries 1`.
### --max-backlog=N ### --max-backlog=int
This is the maximum allowable backlog of files in a sync/copy/move This is the maximum allowable backlog of files in a sync/copy/move
queued for being checked or transferred. queued for being checked or transferred.
@@ -1667,7 +1667,7 @@ Setting `--max-buffer-memory` allows the buffer memory to be
controlled so that it doesn't overwhelm the machine and allows controlled so that it doesn't overwhelm the machine and allows
`--transfers` to be set large. `--transfers` to be set large.
### --max-connections=N ### --max-connections=int
This sets the maximum number of concurrent calls to the backend API. This sets the maximum number of concurrent calls to the backend API.
It may not map 1:1 to TCP or HTTP connections depending on the backend It may not map 1:1 to TCP or HTTP connections depending on the backend
@@ -1693,7 +1693,7 @@ So for `--max-connections 3` you'd use `--checkers 2 --transfers 2
Setting this flag can be useful for backends which do multipart Setting this flag can be useful for backends which do multipart
uploads to limit the number of simultaneous parts being transferred. uploads to limit the number of simultaneous parts being transferred.
### --max-delete=N ### --max-delete=int
This tells rclone not to delete more than N files. If that limit is This tells rclone not to delete more than N files. If that limit is
exceeded then a fatal error will be generated and rclone will stop the exceeded then a fatal error will be generated and rclone will stop the
@@ -1707,7 +1707,7 @@ reached the size specified. It defaults to off.
If that limit is exceeded then a fatal error will be generated and If that limit is exceeded then a fatal error will be generated and
rclone will stop the operation in progress. rclone will stop the operation in progress.
### --max-depth=N ### --max-depth=int
This modifies the recursion depth for all the commands except purge. This modifies the recursion depth for all the commands except purge.
@@ -1973,7 +1973,7 @@ Use `--local-no-sparse` to disable sparse files (which may cause long
delays at the start of transfers) or disable multi-thread transfers delays at the start of transfers) or disable multi-thread transfers
with `--multi-thread-streams 0` with `--multi-thread-streams 0`
### --multi-thread-streams=N ### --multi-thread-streams=int
When using multi thread transfers (see above `--multi-thread-cutoff`) When using multi thread transfers (see above `--multi-thread-cutoff`)
this sets the number of streams to use. Set to `0` to disable multi this sets the number of streams to use. Set to `0` to disable multi
@@ -2110,7 +2110,7 @@ The `--order-by` flag does not do a separate pass over the data. This
means that it may transfer some files out of the order specified if means that it may transfer some files out of the order specified if
- there are no files in the backlog or the source has not been fully scanned yet - there are no files in the backlog or the source has not been fully scanned yet
- there are more than [--max-backlog](#max-backlog-n) files in the backlog - there are more than [--max-backlog](#max-backlog-int) files in the backlog
Rclone will do its best to transfer the best file it has so in Rclone will do its best to transfer the best file it has so in
practice this should not cause a problem. Think of `--order-by` as practice this should not cause a problem. Think of `--order-by` as
@@ -2576,7 +2576,7 @@ becomes idle for this long it is considered broken and disconnected.
The default is `5m`. Set to `0` to disable. The default is `5m`. Set to `0` to disable.
### --transfers=N ### --transfers=int
The number of file transfers to run in parallel. It can sometimes be The number of file transfers to run in parallel. It can sometimes be
useful to set this to a smaller number if the remote is giving a lot useful to set this to a smaller number if the remote is giving a lot

2
docs/content/faq.md
View File

@@ -233,7 +233,7 @@ Restart-Service hns
It is likely you have more than 10,000 files that need to be It is likely you have more than 10,000 files that need to be
synced. By default, rclone only gets 10,000 files ahead in a sync so as synced. By default, rclone only gets 10,000 files ahead in a sync so as
not to use up too much memory. You can change this default with the not to use up too much memory. You can change this default with the
[--max-backlog](/docs/#max-backlog-n) flag. [--max-backlog](/docs/#max-backlog-int) flag.
### Rclone is using too much memory or appears to have a memory leak ### Rclone is using too much memory or appears to have a memory leak