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

add missing CHECKURL-FAILURE ErrorMsg to docs

Browse source
This commit is contained in:
Joey Hess 2020-09-18 11:58:18 -04:00
parent f913822c03
commit 81a38df5a7
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
3 changed files with 22 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/design/external_special_remote_protocol.mdwn
View file

@ -226,7 +226,7 @@ the special remote can reply with `UNSUPPORTED-REQUEST`.
one after the other. one after the other.
Note that since a list is returned, neither the Url nor the Filename Note that since a list is returned, neither the Url nor the Filename
can contain spaces. can contain spaces.
* `CHECKURL-FAILURE` * `CHECKURL-FAILURE ErrorMsg`
Indicates that the requested url could not be accessed. Indicates that the requested url could not be accessed.
* `WHEREIS Key` * `WHEREIS Key`
Asks the remote to provide additional information about ways to access Asks the remote to provide additional information about ways to access

2
doc/todo/external_remotes__58___Add_support_for_ErrorMsg_to_-FAILURE_messages_lacking_it.mdwn
View file

@ -28,3 +28,5 @@ git-annex version: 8.20200810+git143-gdee38c54d-1~ndall+1
[[!meta author=yoh]] [[!meta author=yoh]]
[[!tag projects/datalad]] [[!tag projects/datalad]]
> [[fixed|done]] the documentation --[[Joey]]

19
doc/todo/external_remotes__58___Add_support_for_ErrorMsg_to_-FAILURE_messages_lacking_it/comment_1_a096df37d5bc5543b574b32554311af9._comment Normal file
View file

@ -0,0 +1,19 @@
[[!comment format=mdwn
username="joey"
subject="""comment 1"""
date="2020-09-18T15:50:11Z"
content="""
CHECKURL-FAILURE actually supports an error message,
always has. The docs were just wrong.
CHECKPRESENT-FAILURE is not for an exceptional case,
but a usual case. CHECKPRESENT-UNKNOWN is for the exceptional case and
includes an error message.
CLAIMURL-FAILURE means the remote does not claim the url, so there is no
need for an error message since git-annex will use web as usual.
WHEREIS-FAILURE means the remote does not have information for whereis,
it's not an exceptional case. Especially since WHEREIS is not supposed to
use network access or anything.
"""]]