From f77b7c0a22a874a939f20151d0d969e6d2dbadd2 Mon Sep 17 00:00:00 2001 From: Tobias Langer Date: Fri, 14 Mar 2025 08:54:22 +0100 Subject: [PATCH 1/4] docs: add note on how to run set connection in docker container --- src/cli.rs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/cli.rs b/src/cli.rs index 62ae41e..3976811 100644 --- a/src/cli.rs +++ b/src/cli.rs @@ -313,7 +313,9 @@ pub enum SshConfig { compress_image: Option, }, - /// set ssh connection parameters (currently not working in docker image) + /// set ssh connection parameters (see + /// https://github.com/omnect/omnect-cli?tab=readme-ov-file#usage-with-docker + /// for details on how to use this command with the docker image) SetConnection { /// username for the login on the device. #[arg(short = 'u', long = "user", default_value = "omnect")] From c59305e4729fcf8f82540b19c24c8b6b78d77915 Mon Sep 17 00:00:00 2001 From: Tobias Langer Date: Fri, 14 Mar 2025 08:54:49 +0100 Subject: [PATCH 2/4] docs: fix invalid help string for docker inject command --- src/cli.rs | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/src/cli.rs b/src/cli.rs index 3976811..9f492be 100644 --- a/src/cli.rs +++ b/src/cli.rs @@ -13,7 +13,14 @@ const COPYRIGHT: &str = "Copyright © 2021 by conplement AG"; #[command(after_help = COPYRIGHT)] /// manage docker containers in a firmware image pub enum Docker { - /// pull and inject a docker image (not supported via omnect-ui container) + /// pull and inject a docker image into the factory partition. + /// + /// Notes: + /// As the this command is injected into the factory partition, the injected + /// image will remain there even after factory resets. + /// + /// This command is currently only supported for native omnect-cli, i.e., it + /// will not work for the omnect-cli docker image. Inject { /// full qualified name of the docker image #[clap(short = 'd', long = "docker-image", required(true))] From 8b128d823c47575837b48fdd1a45bdc1f42fef05 Mon Sep 17 00:00:00 2001 From: Tobias Langer Date: Fri, 14 Mar 2025 08:56:02 +0100 Subject: [PATCH 3/4] chore: bump version to 0.24.16 --- Cargo.lock | 2 +- Cargo.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 1e49c94..12bed4c 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -2401,7 +2401,7 @@ dependencies = [ [[package]] name = "omnect-cli" -version = "0.24.15" +version = "0.24.16" dependencies = [ "actix-web", "anyhow", diff --git a/Cargo.toml b/Cargo.toml index 84a2434..a11635a 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -7,7 +7,7 @@ license = "MIT OR Apache-2.0" name = "omnect-cli" readme = "README.md" repository = "https://github.com/omnect/omnect-cli" -version = "0.24.15" +version = "0.24.16" [dependencies] actix-web = "4.9" From 07679142224fe8203df669ed798d57155a48facb Mon Sep 17 00:00:00 2001 From: Tobias Langer Date: Mon, 17 Mar 2025 13:06:13 +0100 Subject: [PATCH 4/4] docs: fix errors in CLI command docs --- src/cli.rs | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/cli.rs b/src/cli.rs index 9f492be..551ccfb 100644 --- a/src/cli.rs +++ b/src/cli.rs @@ -15,12 +15,12 @@ const COPYRIGHT: &str = "Copyright © 2021 by conplement AG"; pub enum Docker { /// pull and inject a docker image into the factory partition. /// - /// Notes: - /// As the this command is injected into the factory partition, the injected - /// image will remain there even after factory resets. + /// Note: This command injects the docker image into the factory partition. + /// Therefore, the injected image will remain there even after factory + /// resets. /// - /// This command is currently only supported for native omnect-cli, i.e., it - /// will not work for the omnect-cli docker image. + /// Furthermore, the command is currently only supported for native + /// omnect-cli, i.e., it will not work for the omnect-cli docker image. Inject { /// full qualified name of the docker image #[clap(short = 'd', long = "docker-image", required(true))]