notes on ImportableContents history not being used for retrieval

This commit is contained in:
Joey Hess 2020-12-22 11:23:00 -04:00
parent bcd55b365c
commit c2d6f335a6
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
2 changed files with 9 additions and 1 deletions

View file

@ -59,6 +59,12 @@ data ImportableContents info = ImportableContents
-- ^ Used by remotes that support importing historical versions of
-- files that are stored in them. This is equivilant to a git
-- commit history.
--
-- When retrieving a historical version of a file,
-- old ImportLocations from importableHistory are not used;
-- the content is no longer expected to be present at those
-- locations. So, if a remote does not support Key/Value access,
-- it should not populate the importableHistory.
}
deriving (Show, Generic)

View file

@ -168,6 +168,8 @@ support a request, it can reply with `UNSUPPORTED-REQUEST`.
block of responses. This can be repeated any number of times
(indicating a branching history), and histories can also
be nested multiple levels deep.
This should only be used when the remote supports using
"TRANSFER RECEIVE Key" to retrieve historical versions of files.
* `END`
Indicates the end of a block of responses.
* `LOCATION Name`