summaryrefslogtreecommitdiff
path: root/doc/design/external_special_remote_protocol.mdwn
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2014-07-28 14:37:22 -0400
committerGravatar Joey Hess <joey@kitenet.net>2014-07-28 14:37:22 -0400
commitdc2369a437b14d4ea6a84d8b756c8b11db15fc85 (patch)
treeee96dfe3f5449cacad3f52f4556156cd3fae2672 /doc/design/external_special_remote_protocol.mdwn
parent0f4098e4e8d13dbeb43b12a6de4449795224835e (diff)
make explicit the implicit requirement that CHECKPRESENT not say a key is present until it's all done being stored
Diffstat (limited to 'doc/design/external_special_remote_protocol.mdwn')
-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 6fe09ff7c..01ffe7fd4 100644
--- a/doc/design/external_special_remote_protocol.mdwn
+++ b/doc/design/external_special_remote_protocol.mdwn
@@ -101,12 +101,14 @@ The following requests *must* all be supported by the special remote.
Tells the special remote it's time to prepare itself to be used.
Only INITREMOTE can come before this.
* `TRANSFER STORE|RETRIEVE Key File`
- Requests the transfer of a key. For Send, the File is the file to upload;
- for Receive the File is where to store the download.
+ Requests the transfer of a key. For STORE, the File is the file to upload;
+ for RETRIEVE the File is where to store the download.
Note that the File should not influence the filename used on the remote.
The filename will not contain any whitespace.
+ Note that it's important that, while a Key is being stored, CHECKPRESENT
+ not indicate it's present until all the data has been transferred.
Multiple transfers might be requested by git-annex, but it's fine for the
- program to serialize them and only do one at a time.
+ program to serialize them and only do one at a time.
* `CHECKPRESENT Key`
Requests the remote check if a key is present in it.
* `REMOVE Key`
@@ -286,7 +288,6 @@ start a new process the next time it needs to use a remote.
the remote. However, \n and probably \0 need to be escaped somehow in the
file data, which adds complication.
* uuid discovery during INITREMOTE.
-* Support for splitting files into chunks.
* Support for getting and setting the list of urls that can be associated
with a key.
* Hook into webapp. Needs a way to provide some kind of prompt to the user