Various updates for --progress-fd
#961
Conversation
antheas
changed the title
cgwalters
force-pushed
the
progress-docs
branch
from
1653fdc to
0d4436b
Compare
|
I did some tweaks here, though we still need to generate a schema for the progress and probably clarify even more strongly the guidelines for how we evolve it. |
cgwalters
force-pushed
the
progress-docs
branch
from
0d4436b to
06aef6d
Compare
github-actions
bot
added
the
documentation
|
Would also be good to decide if you prefer |
cgwalters
force-pushed
the
progress-docs
branch
2 times, most recently
from
280f659 to
17a656a
Compare
I think we should use a semantic version here instead (without any namespace prefixing because it's obvious the data here is coming from bootc), and a semantic version would allow us to better track protocol evolutions (e.g. a client can know to expect new fields). That said of course in practice JSON often used precisely because it's "loose" and new fields can be added at any time. Really also instead of having a version number in each event, I think it'd make sense to emit that version once as a special event type. |
Have the printer take ownership and return it. This is generally prep for making the writer more stateful which will make it easier to work with. Signed-off-by: Colin Walters <[email protected]>
The format is not as important as what the option *does*. There's multiple things that can be JSON, but this is specifically about dynamic progress information. Signed-off-by: Colin Walters <[email protected]>
We're still debating some of the interface/semantics here so let's mark this as hidden. Signed-off-by: Colin Walters <[email protected]>
Signed-off-by: Antheas Kapenekakis <[email protected]> Signed-off-by: Colin Walters <[email protected]>
cgwalters
force-pushed
the
progress-docs
branch
from
17a656a to
ba81bce
Compare
Pushed a commit here that does that. |
cgwalters
force-pushed
the
progress-docs
branch
from
ba81bce to
74d635f
Compare
And use a semantic version for the API version as this allows a clearer evolution. Signed-off-by: Colin Walters <[email protected]>
cgwalters
force-pushed
the
progress-docs
branch
from
74d635f to
63d1199
Compare
cgwalters
changed the title
--progress-fd
| While the `bootc status` tooling allows a client to discover the state | ||
| of the system, during interactive changes such as `bootc upgrade` | ||
| or `bootc switch` it is possible to monitor the status of downloads | ||
| or other operations at a fine-grained level with `-progress-fd`. |
There was a problem hiding this comment.
missing a - in --progress-fd
| // For messages that can be dropped, if we already sent an update within this cycle, discard this one. | ||
| // TODO: Also consider querying the pipe buffer and also dropping if we can't do this write. | ||
| // TODO: Also consider querying the pipe buffer and also dropping if wqe can't do this write. |
|
missed that automerge was on, will file typo fix followup :) |
Signed-off-by: John Eckersberg <[email protected]>
deploy: Avoid cloning progress
Have the printer take ownership and return it. This is generally
prep for making the writer more stateful which will make it easier
to work with.
Signed-off-by: Colin Walters [email protected]
cli: Rename --json-fd to --progress-fd
The format is not as important as what the option does. There's
multiple things that can be JSON, but this is specifically
about dynamic progress information.
Signed-off-by: Colin Walters [email protected]
cli: Make --progress-fd hide=true for now
We're still debating some of the interface/semantics here
so let's mark this as hidden.
Signed-off-by: Colin Walters [email protected]
docs: Describe
--progress-fd, add rendered JSON schemaSigned-off-by: Antheas Kapenekakis [email protected]
Signed-off-by: Colin Walters [email protected]