From 530caa1c2421e38be1871b841bfc342c74a554ca Mon Sep 17 00:00:00 2001 From: Colin Walters Date: Thu, 19 Oct 2023 13:24:16 -0400 Subject: [PATCH] cli: Expand on the status of status - Add a bit more to the doc info - Add explicit warning it's not stable Signed-off-by: Colin Walters --- lib/src/cli.rs | 4 ++++ lib/src/status.rs | 2 ++ 2 files changed, 6 insertions(+) diff --git a/lib/src/cli.rs b/lib/src/cli.rs index 156f0a20a..56c6b5f10 100644 --- a/lib/src/cli.rs +++ b/lib/src/cli.rs @@ -135,6 +135,10 @@ pub(crate) enum Opt { /// Change host specification Edit(EditOpts), /// Display status + /// + /// This will output a YAML-formatted object using a schema intended to match a Kubernetes resource + /// that describes the state of the booted container. + /// The exact API format is not currently declared stable. Status(StatusOpts), /// Add a transient writable overlayfs on `/usr` that will be discarded on reboot. #[clap(alias = "usroverlay")] diff --git a/lib/src/status.rs b/lib/src/status.rs index b74721087..4442a4666 100644 --- a/lib/src/status.rs +++ b/lib/src/status.rs @@ -253,6 +253,8 @@ pub(crate) async fn status(opts: super::cli::StatusOpts) -> Result<()> { host }; + eprintln!("note: The format of this API is not yet stable"); + // If we're in JSON mode, then convert the ostree data into Rust-native // structures that can be serialized. // Filter to just the serializable status structures.