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

document what importKey returning Nothing does

Browse source 
That was added for thirdpartypopulated remotes, but for others it also
has the effect of skipping including the file in the imported tree.
This commit is contained in:
Joey Hess 2020-12-30 13:21:40 -04:00
parent c88008beca
commit cefbfc678d
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
2 changed files with 6 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
Types/Remote.hs
View file

@ -307,10 +307,12 @@ data ImportActions a = ImportActions
-- bearing in mind that the file on the remote may have changed -- bearing in mind that the file on the remote may have changed
-- since the ContentIdentifier was generated. -- since the ContentIdentifier was generated.
-- --
-- When it returns nothing, the file at the ImportLocation
-- not by included in the imported tree.
--
-- When the remote is thirdPartyPopulated, this should check if the -- When the remote is thirdPartyPopulated, this should check if the
-- file stored on the remote is the content of an annex object, -- file stored on the remote is the content of an annex object,
-- and return its Key, or Nothing if it is not. Should not -- and return its Key, or Nothing if it is not.
-- otherwise return Nothing.
-- --
-- Throws exception on failure to access the remote. -- Throws exception on failure to access the remote.
, importKey :: Maybe (ImportLocation -> ContentIdentifier -> ByteSize -> MeterUpdate -> a (Maybe Key)) , importKey :: Maybe (ImportLocation -> ContentIdentifier -> ByteSize -> MeterUpdate -> a (Maybe Key))

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

@ -203,6 +203,8 @@ support a request, it can reply with `UNSUPPORTED-REQUEST`.
ContentIdentifier specified by `EXPECTED`, or otherwise fail. ContentIdentifier specified by `EXPECTED`, or otherwise fail.
Replies: Replies:
* `IMPORTKEY-SUCCESS Key` * `IMPORTKEY-SUCCESS Key`
* `IMPORTKEY-SKIP`
This causes nothing to be imported for this file.
* `IMPORTKEY-FAILURE ErrorMsg` * `IMPORTKEY-FAILURE ErrorMsg`
* `RETRIEVEEXPORTEXPECTED File` * `RETRIEVEEXPORTEXPECTED File`
Retrieves the content of a file from the special remote Retrieves the content of a file from the special remote