From ba6b396a97629ce2c3c3c98e01dccf930834e2b8 Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Fri, 22 Mar 2019 09:59:56 -0400 Subject: [PATCH] improve docs --- ..._616cc2f7d729682c69a9379df785dda5._comment | 12 +++++++++ doc/special_remotes.mdwn | 5 ++-- doc/special_remotes/rsync.mdwn | 26 ++++++++----------- 3 files changed, 26 insertions(+), 17 deletions(-) create mode 100644 doc/forum/Special_remotes_description_misleading/comment_2_616cc2f7d729682c69a9379df785dda5._comment diff --git a/doc/forum/Special_remotes_description_misleading/comment_2_616cc2f7d729682c69a9379df785dda5._comment b/doc/forum/Special_remotes_description_misleading/comment_2_616cc2f7d729682c69a9379df785dda5._comment new file mode 100644 index 0000000000..70bb2bd6c0 --- /dev/null +++ b/doc/forum/Special_remotes_description_misleading/comment_2_616cc2f7d729682c69a9379df785dda5._comment @@ -0,0 +1,12 @@ +[[!comment format=mdwn + username="joey" + subject="""comment 2""" + date="2019-03-22T13:58:06Z" + content=""" +Thanks, I see how that could be confusing and have adjusted the +description. + +annex-rsync-transport will work, but you have to put it in the +configuration of the remote you want it to apply to. annex.rsync-transport +sets it for all rsync remotes. +"""]] diff --git a/doc/special_remotes.mdwn b/doc/special_remotes.mdwn index 6809c5e856..0ae4346ed0 100644 --- a/doc/special_remotes.mdwn +++ b/doc/special_remotes.mdwn @@ -4,8 +4,9 @@ local and remote), that store the file contents in their own git-annex directory. But, git-annex also extends git's concept of remotes, with these special -types of remotes. These can be used just like any normal remote by git-annex. -They cannot be used by other git commands though. +types of remotes. These can be used by git-annex to store and retrieve +the content of files. They cannot be used by other git commands, and +the git history is not stored in them. * [[adb]] (for Android devices) * [[Amazon_Glacier|glacier]] diff --git a/doc/special_remotes/rsync.mdwn b/doc/special_remotes/rsync.mdwn index 7d30b4092a..96e452b103 100644 --- a/doc/special_remotes/rsync.mdwn +++ b/doc/special_remotes/rsync.mdwn @@ -38,27 +38,23 @@ These parameters can be passed to `git annex initremote` to configure rsync: This is typically not a win for rsync, so no need to enable it. But, it makes this interoperate with the [[directory]] special remote. -The `annex-rsync-options` git configuration setting can be used to pass -parameters to rsync. +The `remote.name.annex-rsync-options` git configuration setting can be used +to pass parameters to rsync. To pass parameters to rsync only when it's +downloading and uploading, use `remote.name.annex-rsync-download-options` +and `remote.name.annex-rsync-upload-options` ## annex-rsync-transport -You can use the `annex-rsync-transport` git configuration setting to choose -whether we run rsync over ssh or rsh. This setting is also used to specify -parameters that git annex will pass to ssh/rsh. +You can use the `remote.name.annex-rsync-transport` git configuration +setting to choose whether we run rsync over ssh or rsh. This setting +is also used to specify parameters that git annex will pass to ssh/rsh. -ssh is the default transport; if you'd like to run rsync over rsh, modify your -.git/config to include +ssh is the default transport; if you'd like to run rsync over rsh: - annex-rsync-transport = rsh - -under the appropriate remote. + git config remote.name.annex-rsync-transport rsh To pass parameters to ssh/rsh, include the parameters after "rsh" or "ssh". For example, to configure ssh to use the private key at -`/path/to/private/key`, specify +`/path/to/private/key`: - annex-rsync-transport = ssh -i /path/to/private/key - -Note that environment variables aren't expanded here, so for example, you -cannot specify `-i $HOME/.ssh/private_key`. + git config renote.name.annex-rsync-transport "ssh -i /path/to/private/key"