diff options
Diffstat (limited to 'doc')
3 files changed, 21 insertions, 1 deletions
diff --git a/doc/design/external_special_remote_protocol.mdwn b/doc/design/external_special_remote_protocol.mdwn index 401c42d6c..e31ee9e9b 100644 --- a/doc/design/external_special_remote_protocol.mdwn +++ b/doc/design/external_special_remote_protocol.mdwn @@ -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 diff --git a/doc/todo/INFO_message_for_custom_special_remotes.mdwn b/doc/todo/INFO_message_for_custom_special_remotes.mdwn index b41ea89bc..b2ed38258 100644 --- a/doc/todo/INFO_message_for_custom_special_remotes.mdwn +++ b/doc/todo/INFO_message_for_custom_special_remotes.mdwn @@ -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]] diff --git a/doc/todo/INFO_message_for_custom_special_remotes/comment_1_ea99a5099f78767859c05aeb5217a12d._comment b/doc/todo/INFO_message_for_custom_special_remotes/comment_1_ea99a5099f78767859c05aeb5217a12d._comment new file mode 100644 index 000000000..c2e9f318e --- /dev/null +++ b/doc/todo/INFO_message_for_custom_special_remotes/comment_1_ea99a5099f78767859c05aeb5217a12d._comment @@ -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.) +"""]] |