summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/design/external_special_remote_protocol.mdwn13
-rwxr-xr-xdoc/special_remotes/external/git-annex-remote-ipfs2
-rw-r--r--doc/special_remotes/ipfs.mdwn3
3 files changed, 13 insertions, 5 deletions
diff --git a/doc/design/external_special_remote_protocol.mdwn b/doc/design/external_special_remote_protocol.mdwn
index cc3bfce96..0746a7be1 100644
--- a/doc/design/external_special_remote_protocol.mdwn
+++ b/doc/design/external_special_remote_protocol.mdwn
@@ -274,10 +274,19 @@ in control.
Gets any state that has been stored for the key.
(git-annex replies with VALUE followed by the state.)
* `SETURLPRESENT Key Url`
- Records an url (or uri) where the Key can be downloaded from.
+ Records an URL where the Key can be downloaded from.
* `SETURLMISSING Key Url`
Records that the key can no longer be downloaded from the specified
- url (or uri).
+ URL.
+* `SETURIPRESENT Key Uri`
+ Records a special URI where the Key can be downloaded from.
+ For example, "ipfs:ADDRESS" is used for the ipfs special remote;
+ its CLAIMURL handler checks for such URIS and claims them. Setting
+ it present as an URI makes `git annex whereis` display the URI
+ as belonging to the special remote.
+* `SETURIMISSING Key Uri`
+ Records that the key can no longer be downloaded from the specified
+ URI.
* `GETURLS Key Prefix`
Gets the recorded urls where a Key can be downloaded from.
Only urls that start with the Prefix will be returned. The Prefix
diff --git a/doc/special_remotes/external/git-annex-remote-ipfs b/doc/special_remotes/external/git-annex-remote-ipfs
index fc91aefc8..c8d97ef5c 100755
--- a/doc/special_remotes/external/git-annex-remote-ipfs
+++ b/doc/special_remotes/external/git-annex-remote-ipfs
@@ -89,7 +89,7 @@ while read line; do
if [ -z "$addr" ]; then
echo TRANSFER-FAILURE STORE "$key" "ipfs add failed"
else
- echo "SETURLPRESENT" "$key" "$(addresstourl "$addr")"
+ echo "SETURIPRESENT" "$key" "$(addresstourl "$addr")"
echo TRANSFER-SUCCESS STORE "$key"
fi
;;
diff --git a/doc/special_remotes/ipfs.mdwn b/doc/special_remotes/ipfs.mdwn
index 42e92fde7..5a31a2528 100644
--- a/doc/special_remotes/ipfs.mdwn
+++ b/doc/special_remotes/ipfs.mdwn
@@ -7,8 +7,7 @@ keep your data safe while you're using ipfs.
## prerequisites
-* git-annex version 5.20141219 or newer, which has [[external]] special remote
- support.
+* git-annex version 5.20150305 or newer.
* Install [[external/git-annex-remote-ipfs]] somewhere in PATH
and `chmod +x` the script.
* Install [go-ipfs](https://github.com/jbenet/go-ipfs) somewhere in PATH.