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

some improvements to docs

Browse source
This commit is contained in:
Joey Hess 2019-11-11 12:52:45 -04:00
parent f07d61c376
commit 925b2acb34
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
1 changed files with 9 additions and 7 deletions

16
doc/design/external_special_remote_protocol/export_and_import_appendix.mdwn
View file

@ -164,13 +164,15 @@ support a request, it can reply with `UNSUPPORTED-REQUEST`.
* `END` * `END`
Indicates the end of a block of responses. Indicates the end of a block of responses.
* `LOCATION Name` * `LOCATION Name`
Comes before each of the following requests, Comes before each of the following requests (except for
REMOVEEXPORTDIRECTORYWHENEMPTY),
specifying the name of the file on the remote. It will be in the specifying the name of the file on the remote. It will be in the
form of a relative path, and may contain path separators, form of a relative path, and may contain path separators,
whitespace, and other special characters. whitespace, and other special characters.
No response is made to this message. No response is made to this message.
* `EXPECTED ContentIdentifier` * `EXPECTED ContentIdentifier`
Comes before each of the following requests, specifying the Comes before each of the following requests (except
for REMOVEEXPORTDIRECTORYWHENEMPTY), specifying the
ContentIdentifier that is expected to be present on the remote. ContentIdentifier that is expected to be present on the remote.
* `NOTHINGEXPECTED` * `NOTHINGEXPECTED`
If no ContentIdentifier is expected to be present, this is sent If no ContentIdentifier is expected to be present, this is sent
@ -224,7 +226,9 @@ support a request, it can reply with `UNSUPPORTED-REQUEST`.
Indicates the content has been removed from the remote. May be returned when Indicates the content has been removed from the remote. May be returned when
the content was already not present. the content was already not present.
* `REMOVE-FAILURE Key ErrorMsg` * `REMOVE-FAILURE Key ErrorMsg`
Indicates that the content was unable to be removed from the remote. Indicates that the content was unable to be removed from the remote,
either because of an access problem, or because it did not match
the ContentIdentifier.
* `REMOVEEXPORTDIRECTORYWHENEMPTY Directory` * `REMOVEEXPORTDIRECTORYWHENEMPTY Directory`
Requests the remote remove an exported directory, so long as it's empty. Requests the remote remove an exported directory, so long as it's empty.
If the remote does not use directories, or `REMOVEEXPORTEXPECTED` If the remote does not use directories, or `REMOVEEXPORTEXPECTED`
@ -294,11 +298,9 @@ of the older versions.)
Next git-annex asks for the content of a file to be retrieved. Next git-annex asks for the content of a file to be retrieved.
LOCATION foo LOCATION foo
EXPECTED 100 48511528411921470 EXPECTED 100 48511528411921470
RETRIEVEEXPORTEXPECTED tmpfile RETRIEVEEXPORTEXPECTED tmpfile
But, the file "foo" has been modified and so the If the requested version no longer exists, the response should be:
ContentIdentifier no longer matches.
RETRIEVE-FAILURE content has changed RETRIEVE-FAILURE content has changed