Skip to content

Commit

Permalink
chore(nvmet): Fix some doc comments.
Browse files Browse the repository at this point in the history
  • Loading branch information
vifino committed Nov 30, 2023
1 parent 72bf7f0 commit 2fe45c9
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 4 deletions.
13 changes: 11 additions & 2 deletions src/bin/nvmet/port.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand All @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions src/bin/nvmet/subsystem.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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<String>,

// Set the serial.
/// Set the serial.
serial: Option<String>,
},
/// Remove an existing Subsystem.
Expand Down

0 comments on commit 2fe45c9

Please sign in to comment.