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

update

Browse source
This commit is contained in:
Joey Hess 2013-12-11 13:56:59 -04:00
parent e800e04d2d
commit 75fda11f74
1 changed files with 8 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
doc/design/external_special_remote_protocol.mdwn
View file

@ -21,6 +21,8 @@ The protocol is line based. Messages are sent in either direction, from
git-annex to the program, and from the program to git-annex. No immediate git-annex to the program, and from the program to git-annex. No immediate
reply is made to any message, instead a later message can be sent to reply. reply is made to any message, instead a later message can be sent to reply.
## example
For example, git-annex might request that a key be sent to the For example, git-annex might request that a key be sent to the
remote (Key will be replaced with the key, and File with a file that has remote (Key will be replaced with the key, and File with a file that has
the content to send): the content to send):
@ -36,6 +38,7 @@ is going on. A common message the program would send is to tell the
progress of the upload (in bytes): progress of the upload (in bytes):
PROGRESS STORE Key 10240 PROGRESS STORE Key 10240
PROGRESS STORE Key 20480
## git-annex messages ## git-annex messages
@ -55,7 +58,9 @@ These are the messages git-annex may send to the special remote program.
Requests the transfer of a key. For Send, the File is the file to upload; 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. Note that the File for Receive the File is where to store the download. Note that the File
should not influence the filename used on the remote. The filename used should not influence the filename used on the remote. The filename used
should be derived from the Key. should be derived from the Key.
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.
* `HAS Key` * `HAS Key`
Requests the remote check if a key is present in it. Requests the remote check if a key is present in it.
* `REMOVE Key` * `REMOVE Key`
@ -64,7 +69,8 @@ These are the messages git-annex may send to the special remote program.
## special remote messages ## special remote messages
These are the messages the special remote program can send. These are the messages the special remote program can send back to
git-annex.
* `VERSION Int` * `VERSION Int`
Supported protocol version. Current version is 0. Must be sent first Supported protocol version. Current version is 0. Must be sent first