@@ -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
1515pub 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