summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Joey Hess <joeyh@joeyh.name>2017-05-09 14:02:48 -0400
committerGravatar Joey Hess <joeyh@joeyh.name>2017-05-09 14:02:48 -0400
commit0fff28623cd12e99a45d6002192d62f1545340df (patch)
treed0af22fd9aa7a4ff42e6217c2e685a09c8b2501a
parent9ca8b85a590f72899e65bb8d9eab758d31e41b49 (diff)
response; update man page
-rw-r--r--doc/git-annex.mdwn4
-rw-r--r--doc/sync/comment_23_e5e7ec9fbafe5e0429161b977e483752._comment24
2 files changed, 28 insertions, 0 deletions
diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn
index 56be4bcf9..44f3b94fc 100644
--- a/doc/git-annex.mdwn
+++ b/doc/git-annex.mdwn
@@ -1217,6 +1217,10 @@ Here are all the supported configuration settings.
to or from this remote. For example, to force IPv6, and limit
the bandwidth to 100Kbyte/s, set it to `-6 --bwlimit 100`
+ Note that git-annex-shell has a whitelist of allowed rsync options,
+ and others will not be be passed to the remote rsync. So using some
+ options may break the communication between the local and remote rsyncs.
+
* `remote.<name>.annex-rsync-upload-options`
Options to use when using rsync to upload a file to a remote.
diff --git a/doc/sync/comment_23_e5e7ec9fbafe5e0429161b977e483752._comment b/doc/sync/comment_23_e5e7ec9fbafe5e0429161b977e483752._comment
new file mode 100644
index 000000000..cfb62ba11
--- /dev/null
+++ b/doc/sync/comment_23_e5e7ec9fbafe5e0429161b977e483752._comment
@@ -0,0 +1,24 @@
+[[!comment format=mdwn
+ username="joey"
+ subject="""comment 23"""
+ date="2017-05-09T17:52:11Z"
+ content="""
+@mario, great question! (Not the best place for such a question, start a
+thread on the forum next time..)
+
+git-annex does use rsync when transferring files between ssh remotes.
+Rsync normally goes over ssh, and it might be better to enable compression
+at the ssh level. For example, I have "Compression yes" in `~/.ssh/config`
+
+I think that the reason your annex-rsync-upload-options setting broke
+it is that rsync needs --compress to be passed on to the other
+rsync process (in the remote repository), and that is run via
+git-annex-shell, which has a whitelist of options it will pass to rsync.
+Passing arbitrary options to rsync could allow unwanted behavior
+when git-annex-shell is being used as a security barrier. And --compress is
+one of the options that both the rsync sender and receiver have to agree
+on for the rsync protocol to work.
+
+I have added a note to the man page about this limitation of what
+the rsync-options settings can be used to do.
+"""]]