diff options
| author |  Joey Hess <joey@kitenet.net> | 2014-01-13 14:41:10 -0400 |
|---|---|---|
| committer | Joey Hess <joey@kitenet.net> | 2014-01-13 14:41:10 -0400 |
| commit | fa7934c035ff09b46d646353683c6d9745f0c94d (patch) | |
| tree | ccdbbe618762679e9bc2932e8d92bbee86067fd9 /doc | |
| parent | 2d9784fae4ea1830865bc77de1a1c4c1b4ce3714 (diff) | |
add GETAVAILABILITY to external special remote protocol
And some reworking of types, and added an annex-availability git config
setting.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/design/external_special_remote_protocol.mdwn | 8 | ||||
| -rw-r--r-- | doc/git-annex.mdwn | 5 |
2 files changed, 13 insertions, 0 deletions
diff --git a/doc/design/external_special_remote_protocol.mdwn b/doc/design/external_special_remote_protocol.mdwn index 85df31681..ef09148db 100644 --- a/doc/design/external_special_remote_protocol.mdwn +++ b/doc/design/external_special_remote_protocol.mdwn @@ -118,6 +118,11 @@ replying with `UNSUPPORTED-REQUEST` is acceptable. * `GETCOST` Requests the remote return a use cost. Higher costs are more expensive. (See Config/Cost.hs for some standard costs.) +* `GETAVAILABILITY` + Requests the remote send back an `AVAILABILITY` reply. + If the remote replies with `UNSUPPORTED-REQUEST`, its availability + is asssumed to be global. So, only remotes that are only reachable + locally need to worry about implementing this. More optional requests may be added, without changing the protocol version, so if an unknown request is seen, reply with `UNSUPPORTED-REQUEST`. @@ -153,6 +158,9 @@ while it's handling a request. Indicates that the key was unable to be removed from the remote. * `COST Int` Indicates the cost of the remote. +* `AVAILABILITY GLOBAL|LOCAL` + Indicates if the remote is globally or only locally available. + (Ie stored in the cloud vs on a local disk.) * `INITREMOTE-SUCCESS` Indicates the INITREMOTE succeeded and the remote is ready to use. * `INITREMOTE-FAILURE ErrorMsg` diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn index 2071f515c..4f802f4e3 100644 --- a/doc/git-annex.mdwn +++ b/doc/git-annex.mdwn @@ -1297,6 +1297,11 @@ Here are all the supported configuration settings. configured by the trust and untrust commands. The value can be any of "trusted", "semitrusted" or "untrusted". +* `remote.<name>.availability` + + Can be used to tell git-annex whether a remote is LocallyAvailable + or GloballyAvailable. Normally, git-annex determines this automatically. + * `remote.<name>.annex-ssh-options` Options to use when using ssh to talk to this remote. |