improve docs about removeExportDirectory

This commit is contained in:
Joey Hess 2019-05-28 11:12:53 -04:00
parent 8960f259b8
commit c1ed0293b0
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
3 changed files with 7 additions and 3 deletions

View file

@ -81,6 +81,8 @@ gen r u c gc = do
, retrieveExportWithContentIdentifier = retrieveExportWithContentIdentifierM dir
, storeExportWithContentIdentifier = storeExportWithContentIdentifierM dir
, removeExportWithContentIdentifier = removeExportWithContentIdentifierM dir
-- Not needed because removeExportWithContentIdentifier
-- auto-removes empty directories.
, removeExportDirectoryWhenEmpty = Nothing
, checkPresentExportWithContentIdentifier = checkPresentExportWithContentIdentifierM dir
}

View file

@ -198,8 +198,8 @@ replying with `UNSUPPORTED-REQUEST` is acceptable.
respond with `REMOVE-SUCCESS`.
* `REMOVEEXPORTDIRECTORY Directory`
Requests the remote remove an exported directory.
If the remote does not use directories, or automatically cleans up
empty directories, this does not need to be implemented.
If the remote does not use directories, or REMOVEEXPORT cleans up
directories that are empty, this does not need to be implemented.
The directory will be in the form of a relative path, and may contain path
separators, whitespace, and other special characters.
Typically the directory will be empty, but it could possibly contain

View file

@ -281,7 +281,9 @@ the race.
removeExportDirectoryWhenEmpty is used instead of removeExportDirectory.
It should only remove empty directories, and succeeds if there are files
in the directory.
in the directory. This is needed because removeExportDirectory removes
non-empty directories, but when importing the stuff in those directories is
stuff that ought to be imported.
checkPresentExportWithContentIdentifier is used instead of
checkPresentExport. It should verify that one of the provided