mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

don't send PREPARE before INITREMOTE

Browse source 
That complicated special remote programs, because they had to avoid making
PREPARE fail if some configuration is missing, because the remote might not
be initialized yet. Instead, complicate git-annex slightly by only sending
PREPARE immediately before some other request other than INITREMOTE (or
PREPARE of course).
This commit is contained in:
Joey Hess 2013-12-27 02:49:10 -04:00
parent 5b7c38c90a
commit 3289155e28
3 changed files with 31 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

17
doc/design/external_special_remote_protocol.mdwn
View file

@ -36,8 +36,9 @@ the version of the protocol it is using.
VERSION 1
Once it knows the version, git-annex will send a message telling the
special remote to start up.
Once it knows the version, git-annex will generally
send a message telling the special remote to start up.
(Or it might send a INITREMOTE, so don't hardcode this order.)
PREPARE
@ -84,17 +85,15 @@ send one of the corresponding replies listed in the next section.
The following requests *must* all be supported by the special remote.
* `PREPARE`
Tells the special remote it's time to prepare itself to be used.
Only run once, at startup, always immediately after the special remote
sends VERSION.
* `INITREMOTE`
Request that the remote initialized itself. This is where any one-time
Request that the remote initialize itself. This is where any one-time
setup tasks can be done, for example creating an Amazon S3 bucket.
(PREPARE is still sent before this.)
Note: This may be run repeatedly, as a remote is initialized in
Note: This may be run repeatedly over time, as a remote is initialized in
different repositories, or as the configuration of a remote is changed.
So any one-time setup tasks should be done idempotently.
* `PREPARE`
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.