Skip to content

Commit c59305e

Browse files
committed
docs: fix invalid help string for docker inject command
1 parent f77b7c0 commit c59305e

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

src/cli.rs

Lines changed: 8 additions & 1 deletion
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+
/// Notes:
19+
/// As the this command is injected into the factory partition, the injected
20+
/// image will remain there even after factory resets.
21+
///
22+
/// This command is currently only supported for native omnect-cli, i.e., it
23+
/// 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))]

0 commit comments

Comments
 (0)