summaryrefslogtreecommitdiff
path: root/doc/special_remotes
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2011-04-29 11:16:54 -0400
committerGravatar Joey Hess <joey@kitenet.net>2011-04-29 11:16:54 -0400
commit0ea7f966dc61948d107372fac6f2ec90a1dc28f5 (patch)
tree4f54bdb91d52d022f50b0dca0c5ee4efef1d37e5 /doc/special_remotes
parent3d22364bcbb190b12c3cf1fd01658d78f1f4b9fd (diff)
add git annex describe to special remote setup examples
Diffstat (limited to 'doc/special_remotes')
-rw-r--r--doc/special_remotes/directory.mdwn1
-rw-r--r--doc/special_remotes/hook.mdwn1
-rw-r--r--doc/special_remotes/rsync.mdwn2
3 files changed, 4 insertions, 0 deletions
diff --git a/doc/special_remotes/directory.mdwn b/doc/special_remotes/directory.mdwn
index 9e4bfa33b..0a38c763c 100644
--- a/doc/special_remotes/directory.mdwn
+++ b/doc/special_remotes/directory.mdwn
@@ -8,3 +8,4 @@ the drive's mountpoint as a directory remote.
Setup example:
# git annex initremote usbdrive type=directory directory=/media/usbdrive/ encryption=none
+ # git annex describe usbdrive "usb drive on /media/usbdrive/"
diff --git a/doc/special_remotes/hook.mdwn b/doc/special_remotes/hook.mdwn
index e3b70d202..5b636613c 100644
--- a/doc/special_remotes/hook.mdwn
+++ b/doc/special_remotes/hook.mdwn
@@ -16,6 +16,7 @@ next Apert! :) --[[Joey]]
# git config annex.cuneiform-remove-hook 'librarian --get --floor=$ANNEX_HASH_1 --shelf=$ANNEX_HASH_2 --title="$ANNEX_KEY" | goon --hit-with-hammer'
# git config annex.cuneiform-checkpresent-hook 'librarian --find --force-distrust-catalog --floor=$ANNEX_HASH_1 --shelf=$ANNEX_HASH_2 --title="$ANNEX_KEY" --shout-title'
# git annex initremote library type=hook hooktype=cuneiform encryption=none
+ # git annex describe library "the reborn Library of Alexandria (upgrade to bronze plates pending)"
Can you spot the potential data loss bugs in the above simple example?
(Hint: What happens when the `tablet-proofreader` exits nonzero?)
diff --git a/doc/special_remotes/rsync.mdwn b/doc/special_remotes/rsync.mdwn
index 7a7f3ab14..90d544a1e 100644
--- a/doc/special_remotes/rsync.mdwn
+++ b/doc/special_remotes/rsync.mdwn
@@ -3,10 +3,12 @@ This special remote type rsyncs file contents to somewhere else.
Setup example:
# git annex initremote myrsync type=rsync rsyncurl=rsync://rsync.example.com/myrsync encryption=joey@kitenet.net
+ # git annex describe myrsync "rsync server"
Or for using rsync over SSH
# git annex initremote myrsync type=rsync rsyncurl=ssh.example.com:/myrsync encryption=joey@kitenet.net
+ # git annex describe myrsync "rsync server"
## configuration