summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Joey Hess <joeyh@joeyh.name>2017-03-08 14:26:29 -0400
committerGravatar Joey Hess <joeyh@joeyh.name>2017-03-08 14:26:29 -0400
commit9fcaecb288d7eb1eeafd1603a6aa44e62063769f (patch)
tree9036b3cc2b64c5628111b22087ab84462cd65784
parent61e644fb6d5bca42d14b844f20dea57694f87535 (diff)
document get -J's behavior of spreading load amoung same-cost remotes
I implemented this last fall, but forgot to document it anywhere.
-rw-r--r--doc/git-annex-get.mdwn9
1 files changed, 8 insertions, 1 deletions
diff --git a/doc/git-annex-get.mdwn b/doc/git-annex-get.mdwn
index f30ee49e1..b7f2f74b2 100644
--- a/doc/git-annex-get.mdwn
+++ b/doc/git-annex-get.mdwn
@@ -23,7 +23,7 @@ or transferring them from some kind of key-value store.
* `--from=remote`
Normally git-annex will choose which remotes to get the content
- from, preferring less expensive remotes. Use this option to specify
+ from, preferring remotes with lower costs. Use this option to specify
which remote to use.
Any files that are not available on the remote will be silently skipped.
@@ -33,6 +33,13 @@ or transferring them from some kind of key-value store.
Enables parallel download with up to the specified number of jobs
running at once. For example: `-J10`
+ When files can be downloaded from multiple remotes, enabling parallel
+ downloads will split the load between the remotes. For example, if
+ the files are available on remotes A and B, then one file will be
+ downloaded from A, and another file will be downloaded from B in
+ parallel. (Remotes with lower costs are still preferred over higher cost
+ remotes.)
+
* file matching options
The [[git-annex-matching-options]](1)