diff --git a/src/bin/nvmet/port.rs b/src/bin/nvmet/port.rs index 9c15354..455d7ca 100644 --- a/src/bin/nvmet/port.rs +++ b/src/bin/nvmet/port.rs @@ -24,8 +24,17 @@ pub enum CliPortCommands { /// Type of Port. port_type: CliPortType, - // Port Address to use. + /// Port Address to use. + /// + /// For Tcp and Rdma port types, this should be an IP address and Port: + /// IPv4: 1.2.3.4:4420 + /// IPv6: [::1]:4420 + /// + /// For Fibre Channel transport, this should be the WWNN/WWPN in the following format: + /// Long: nn-0x1000000044001123:pn-0x2000000055001123 + /// Short: nn-1000000044001123:pn-2000000055001123 #[arg( + verbatim_doc_comment, required_if_eq("port_type", "tcp"), required_if_eq("port_type", "rdma"), required_if_eq("port_type", "fc") @@ -34,7 +43,7 @@ pub enum CliPortCommands { }, /// Remove a Port. Remove { - // Port ID to remove. + /// Port ID to remove. pid: u16, }, /// List the subsystems provided by a Port. diff --git a/src/bin/nvmet/subsystem.rs b/src/bin/nvmet/subsystem.rs index c3b5639..1012f25 100644 --- a/src/bin/nvmet/subsystem.rs +++ b/src/bin/nvmet/subsystem.rs @@ -24,10 +24,10 @@ pub enum CliSubsystemCommands { /// - nqn.2014-08.org.nvmexpress:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6 sub: String, - // Set the model. + /// Set the model. model: Option, - // Set the serial. + /// Set the serial. serial: Option, }, /// Remove an existing Subsystem.