mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

improve docs

Browse source
This commit is contained in:
Joey Hess 2019-03-22 09:59:56 -04:00
parent 077efce98b
commit ba6b396a97
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
3 changed files with 26 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
doc/forum/Special_remotes_description_misleading/comment_2_616cc2f7d729682c69a9379df785dda5._comment Normal file
View file

@ -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.
"""]]

5
doc/special_remotes.mdwn
View file

@ -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]]

26
doc/special_remotes/rsync.mdwn
View file

@ -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"