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

note commands which do not get a reply

Browse source
This commit is contained in:
Joey Hess 2016-05-23 15:11:39 -04:00
commit 3dd69f932d
Failed to extract signature
1 changed files with 20 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

30
doc/design/external_special_remote_protocol.mdwn
View file

@ -150,7 +150,7 @@ so if an unknown request is seen, reply with `UNSUPPORTED-REQUEST`.
These should be sent only in response to the git-annex request messages. These should be sent only in response to the git-annex request messages.
They do not have to be sent immediately after the request; the special They do not have to be sent immediately after the request; the special
remote can send its own requests (listed in the next section below) remote can send its own messages (listed in the next section below)
while it's handling a request. while it's handling a request.
* `PREPARE-SUCCESS` * `PREPARE-SUCCESS`
@ -220,7 +220,9 @@ in control.
* `VERSION Int` * `VERSION Int`
Supported protocol version. Current version is 1. Must be sent first Supported protocol version. Current version is 1. Must be sent first
thing at startup, as until it sees this git-annex does not know how to thing at startup, as until it sees this git-annex does not know how to
talk with the special remote program! talk with the special remote program!
(git-annex does not send a reply to this message, but may give up if it
doesn't support the necessary protocol version.)
* `PROGRESS Int` * `PROGRESS Int`
Indicates the current progress of the transfer (in bytes). May be repeated Indicates the current progress of the transfer (in bytes). May be repeated
any number of times during the transfer process, but it's wasteful to any number of times during the transfer process, but it's wasteful to
@ -246,7 +248,8 @@ in control.
Normally this is sent during INITREMOTE, which allows these settings Normally this is sent during INITREMOTE, which allows these settings
to be stored in the git-annex branch, so will be available if the same to be stored in the git-annex branch, so will be available if the same
special remote is used elsewhere. (If sent after INITREMOTE, the changed special remote is used elsewhere. (If sent after INITREMOTE, the changed
configuration will only be available while the remote is running.) configuration will only be available while the remote is running.)
(git-annex does not send a reply to this message.)
* `GETCONFIG Setting` * `GETCONFIG Setting`
Gets one of the special remote's configuration settings, which can have Gets one of the special remote's configuration settings, which can have
been passed by the user when running `git annex initremote`, or been passed by the user when running `git annex initremote`, or
@ -264,7 +267,8 @@ in control.
case the creds will be encrypted using it. If creds are not stored in case the creds will be encrypted using it. If creds are not stored in
the configuration, they'll only be stored in a local file. the configuration, they'll only be stored in a local file.
(embedcreds can be set to yes by the user or by SETCONFIG to force (embedcreds can be set to yes by the user or by SETCONFIG to force
the creds to be stored in the remote's configuration). the creds to be stored in the remote's configuration).
(git-annex does not send a reply to this message.)
* `GETCREDS Setting` * `GETCREDS Setting`
Gets any creds that were previously stored in the remote's configuration Gets any creds that were previously stored in the remote's configuration
or a file. or a file.
@ -282,7 +286,8 @@ in control.
this is not configured by a special remote, but it may make sense this is not configured by a special remote, but it may make sense
in some situations to hint at the kind of content that should be stored in some situations to hint at the kind of content that should be stored
in the special remote. Note that if a unparsable expression is set, in the special remote. Note that if a unparsable expression is set,
git-annex will ignore it. git-annex will ignore it.
(git-annex does not send a reply to this message.)
* `GETWANTED` * `GETWANTED`
Gets the current preferred content setting of the repository. Gets the current preferred content setting of the repository.
(git-annex replies with VALUE followed by the preferred content (git-annex replies with VALUE followed by the preferred content
@ -294,7 +299,8 @@ in control.
multiple repositories are using the same special remote, and store multiple repositories are using the same special remote, and store
different state, whichever one stored the state last will win. Also, different state, whichever one stored the state last will win. Also,
it's best to avoid storing much state, since this will bloat the it's best to avoid storing much state, since this will bloat the
git-annex branch. Most remotes will not need to store any state. git-annex branch. Most remotes will not need to store any state.
(git-annex does not send a reply to this message.)
* `GETSTATE Key` * `GETSTATE Key`
Gets any state that has been stored for the key. Gets any state that has been stored for the key.
(git-annex replies with VALUE followed by the state.) (git-annex replies with VALUE followed by the state.)
@ -305,17 +311,21 @@ in control.
Keep in mind that this stores the url in the git-annex branch. This can Keep in mind that this stores the url in the git-annex branch. This can
result in bloat to the branch if the url is large and/or does not delta result in bloat to the branch if the url is large and/or does not delta
pack well with other information (such as the names of keys) already pack well with other information (such as the names of keys) already
stored in the branch. stored in the branch.
(git-annex does not send a reply to this message.)
* `SETURLMISSING Key Url` * `SETURLMISSING Key Url`
Records that the key can no longer be downloaded from the specified Records that the key can no longer be downloaded from the specified
URL. URL.
(git-annex does not send a reply to this message.)
* `SETURIPRESENT Key Uri` * `SETURIPRESENT Key Uri`
Records an URI where the Key can be downloaded from. Records an URI where the Key can be downloaded from.
For example, "ipfs:ADDRESS" is used for the ipfs special remote; For example, "ipfs:ADDRESS" is used for the ipfs special remote;
its CLAIMURL handler checks for such URIS and claims them. its CLAIMURL handler checks for such URIS and claims them.
(git-annex does not send a reply to this message.)
* `SETURIMISSING Key Uri` * `SETURIMISSING Key Uri`
Records that the key can no longer be downloaded from the specified Records that the key can no longer be downloaded from the specified
URI. URI.
(git-annex does not send a reply to this message.)
* `GETURLS Key Prefix` * `GETURLS Key Prefix`
Gets the recorded urls where a Key can be downloaded from. Gets the recorded urls where a Key can be downloaded from.
Only urls that start with the Prefix will be returned. The Prefix Only urls that start with the Prefix will be returned. The Prefix