Skip to content

Commit be1b925

Browse files
authored
docs: fix outdated docs (#142)
1 parent cb4befe commit be1b925

File tree

3 files changed

+13
-4
lines changed

3 files changed

+13
-4
lines changed

Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ license = "MIT OR Apache-2.0"
77
name = "omnect-cli"
88
readme = "README.md"
99
repository = "https://github.com/omnect/omnect-cli"
10-
version = "0.24.15"
10+
version = "0.24.16"
1111

1212
[dependencies]
1313
actix-web = "4.9"

src/cli.rs

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,14 @@ const COPYRIGHT: &str = "Copyright © 2021 by conplement AG";
1313
#[command(after_help = COPYRIGHT)]
1414
/// manage docker containers in a firmware image
1515
pub enum Docker {
16-
/// pull and inject a docker image (not supported via omnect-ui container)
16+
/// pull and inject a docker image into the factory partition.
17+
///
18+
/// Note: This command injects the docker image into the factory partition.
19+
/// Therefore, the injected image will remain there even after factory
20+
/// resets.
21+
///
22+
/// Furthermore, the command is currently only supported for native
23+
/// omnect-cli, i.e., it will not work for the omnect-cli docker image.
1724
Inject {
1825
/// full qualified name of the docker image
1926
#[clap(short = 'd', long = "docker-image", required(true))]
@@ -313,7 +320,9 @@ pub enum SshConfig {
313320
compress_image: Option<Compression>,
314321
},
315322

316-
/// set ssh connection parameters (currently not working in docker image)
323+
/// set ssh connection parameters (see
324+
/// https://github.com/omnect/omnect-cli?tab=readme-ov-file#usage-with-docker
325+
/// for details on how to use this command with the docker image)
317326
SetConnection {
318327
/// username for the login on the device.
319328
#[arg(short = 'u', long = "user", default_value = "omnect")]

0 commit comments

Comments
 (0)