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

Added INFO to external special remote protocol.

Browse source 
It's left up to the special remote to detect when git-annex is new enough
to support the message; an old git-annex will blow up.

This commit was supported by the NSF-funded DataLad project.
This commit is contained in:
Joey Hess 2018-02-06 13:03:55 -04:00
parent 5c8150c6eb
commit 7d9f0e0fbe
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
9 changed files with 59 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

9
doc/design/external_special_remote_protocol.mdwn
View file

@ -400,8 +400,15 @@ handling a request.
(git-annex replies one or more times with VALUE for each url.
The final VALUE has an empty value, indicating the end of the url list.)
* `DEBUG message`
Tells git-annex to display the message if --debug is enabled.
Tells git-annex to display the message if --debug is enabled.
(git-annex does not send a reply to this message.)
* `INFO message`
Tells git-annex to display the message to the user.
When git-annex is in --json mode, the message will be emitted immediately
in its own json object, with an "info" field.
(git-annex does not send a reply to this message.)
This message was first supported by git-annex version
6.20180206
## general messages

2
doc/todo/INFO_message_for_custom_special_remotes.mdwn
View file

@ -1,3 +1,5 @@
I wondered if it would be sensible to ask to extend [externals special remote protocol](https://git-annex.branchable.com/design/external_special_remote_protocol/) with ability for custom remotes to pass back some INFO level message (not only DEBUG or ERROR). The reason is: in datalad-archives special remote we usually need to `git annex get` first the key containing the archive, which might be sizeable. Since there is ATM no way to communicate back to git-annex, so it could communicate back to the datalad which runs it, it results in no output/message to the user that possibly a heavy download is happening in the background. So, we would need to establish our own communication from datalad-archives special remote all the way to top level datalad process to report that, or I wondered if may be we could report back to git-annex, and it in turn report back to the original process (running e.g. `annex get --json --json-progress`) so it could spit out that message wrapped into a json record within the stream, so we could process and output that to the user.
[[!meta author=yoh]]
> [[done]] --[[Joey]]

11
doc/todo/INFO_message_for_custom_special_remotes/comment_1_ea99a5099f78767859c05aeb5217a12d._comment Normal file
View file

@ -0,0 +1,11 @@
[[!comment format=mdwn
username="joey"
subject="""comment 1"""
date="2018-02-06T16:58:04Z"
content="""
I've added it. However, note that previous versions of git-annex will
not react well to an unknown message being sent, so to use it safely you
will need to detect a new enough version of git-annex. (I've had a todo item
on the protocol for a while to have a way to detect what messages git-annex
understands.)
"""]]