summaryrefslogtreecommitdiff
path: root/doc/design
diff options
context:
space:
mode:
authorGravatar Joey Hess <joeyh@joeyh.name>2015-03-05 13:50:15 -0400
committerGravatar Joey Hess <joeyh@joeyh.name>2015-03-05 13:50:15 -0400
commitf3958ecd07765975e4ea3d500cdc9694ad595d5e (patch)
treefeac52e85c2809dbb85de05496c87ecd767adcc8 /doc/design
parentc80bd8d1c3993312dd36888d81bd80b48584fb2d (diff)
Added SETURIPRESENT and SETURIMISSING to external special remote protocol
Useful for things like ipfs that don't use regular urls. An external special remote can add a regular url to a key, and then git-annex get will download it from the web. But for ipfs, we want to instead tell git-annex that the uri uses OtherDownloader. Before this change, the external special remote protocol lacked a way to do that.
Diffstat (limited to 'doc/design')
-rw-r--r--doc/design/external_special_remote_protocol.mdwn13
1 files changed, 11 insertions, 2 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