Adding timestamp end to events endpoint. Modifying api docs.#4821
Adding timestamp end to events endpoint. Modifying api docs.#48211 commit merged intomoby:masterfrom
Conversation
api/client.go
Outdated
There was a problem hiding this comment.
Does this mean that we no longer continue to show events until ctrl-C?
(or just that the doc change is misleading)
perhaps we should have a -f like we do for docker logs -f container
There was a problem hiding this comment.
@SvenDowideit The behaviour is the same as before
There was a problem hiding this comment.
@jimenez the reason I asked, is that the highlighted change does not confirm to the reader that it will indeed still stream.
|
@SvenDowideit @vieux we really need to talk about API docs and automation. |
|
@jamtur01 Yes, my first instinct would be to have only the v1.0 doc, and then only diffs. The doc page would be generated. |
|
@vieux +10. |
|
ping @ostezer :) |
api/client.go
Outdated
There was a problem hiding this comment.
and then there's my other thought - can I do
docker log --since Jan-2014 --until April-2014 ?
(I don't mean the date format, I mean in principle - will it stream until that date, or will it break?)
There was a problem hiding this comment.
I will rebase tomorrow. I assume you were talking about events and not log so docker events --since 2014-01 --until 2014-04 will display events previous to the 'since' date and will stream events until the 'until' flag date. Unless you break it with <Ctrl-C>
|
@jimenez oh, sweet - if its that magical, can you please make the docs say so, cos thats cooler than sliced cheese, but if no-one reads about it, only the experimenters will know |
|
ping @crosbymichael |
There was a problem hiding this comment.
feel free to call me a pedant :) I presume that calling event.Time and comparing it to until is a more computationally expensive thing than comparing until == 0 for each of a crazy number of events until the user hits Ctrl-c
(if not, then I learned something about golang :) )
There was a problem hiding this comment.
@SvenDowideit event.Time isn't a function call, so the effective difference
is negligible :)
There was a problem hiding this comment.
20 years ago i would have compared the asm compiler output out of curiosity - these days - thank you :)
|
@crosbymichael ping |
|
It's time to bump the API version now that @unclejack please take a look. |
|
Docs LGTM |
There was a problem hiding this comment.
Perhaps it might be better to mark until, i.e.,
use the until parameter > use the -until parameter
and,
timestamp > timestamp.
Docker-DCO-1.1-Signed-off-by: Isabel Jimenez <contact@isabeljimenez.com> (github: jimenez)
…ature Adding timestamp end to events endpoint. Modifying api docs.
|
LGTM |
Docker-DCO-1.1-Signed-off-by: Isabel Jimenez contact@isabeljimenez.com (github: jimenez)
fix #3903
ping @crosbymichael