summaryrefslogtreecommitdiff
path: root/doc/design
diff options
context:
space:
mode:
authorGravatar Joey Hess <joeyh@joeyh.name>2017-09-08 14:24:05 -0400
committerGravatar Joey Hess <joeyh@joeyh.name>2017-09-08 14:24:05 -0400
commit23f55c0efdd58f8024d9b0c9e4b02db7b8d27b61 (patch)
treec6e008833ac2526f9681de86e244e23584639613 /doc/design
parent1afbbef018b6a8e5d382c44c5e5366cf6ec65950 (diff)
External special remote protocol extended to support export.
Also updated example.sh to support export. This commit was supported by the NSF-funded DataLad project.
Diffstat (limited to 'doc/design')
-rw-r--r--doc/design/external_special_remote_protocol.mdwn9
1 files changed, 5 insertions, 4 deletions
diff --git a/doc/design/external_special_remote_protocol.mdwn b/doc/design/external_special_remote_protocol.mdwn
index 8a34bb2d7..95ef13041 100644
--- a/doc/design/external_special_remote_protocol.mdwn
+++ b/doc/design/external_special_remote_protocol.mdwn
@@ -153,7 +153,8 @@ replying with `UNSUPPORTED-REQUEST` is acceptable.
Comes immediately before each of the following export-related requests,
specifying the name of the exported file. It will be in the form
of a relative path, and may contain path separators, whitespace,
- and other special characters.
+ and other special characters.
+ No response is made to this message.
* `TRANSFEREXPORT STORE|RETRIEVE Key File`
Requests the transfer of a File on local disk to or from the previously
provided Name on the special remote.
@@ -253,12 +254,12 @@ while it's handling a request.
Indicates that no location is known for a key.
* `EXPORTSUPPORTED-SUCCESS`
Indicates that it makes sense to use this special remote as an export.
-* `EXPORTSUPPORTED`
+* `EXPORTSUPPORTED-FAILURE`
Indicates that it does not make sense to use this special remote as an
export.
-* `RENAMEEXPORT-SUCCESS`
+* `RENAMEEXPORT-SUCCESS Key`
Indicates that a `RENAMEEXPORT` was done successfully.
-* `RENAMEEXPORT-FAILURE`
+* `RENAMEEXPORT-FAILURE Key`
Indicates that a `RENAMEEXPORT` failed for whatever reason.
* `UNSUPPORTED-REQUEST`
Indicates that the special remote does not know how to handle a request.