git: 4451b1de2179 - stable/13 - ctladm.8: fix several errors in the "port" section

The branch stable/13 has been updated by asomers:

URL: https://cgit.FreeBSD.org/src/commit/?id=4451b1de2179cc554489207e6456aaf3252b1e16

commit 4451b1de2179cc554489207e6456aaf3252b1e16
Author:     Alan Somers <asomers@FreeBSD.org>
AuthorDate: 2024-06-05 20:13:04 +0000
Commit:     Alan Somers <asomers@FreeBSD.org>
CommitDate: 2024-06-28 19:00:41 +0000

    ctladm.8: fix several errors in the "port" section
    
    * Document the "-d" option.
    * Add the "-c" and "-r" options to the summary.
    * Correct the list of required options.
    * Clarify that the "-t" option is only for use with "-o", "-w", and "-W"
    * Replace references to the nonexistent "-n" with "-p".
    
    Also, fix a few related error strings in the ctladm command.
    
    Sponsored by:   Axcient
    Reviewed by:    jhb
    Differential Revision: https://reviews.freebsd.org/D45503
    
    (cherry picked from commit 60107d23d8f2c05f418c024000a31a6148d2f7de)
---
 usr.sbin/ctladm/ctladm.8 | 32 ++++++++++++++++++++++++++++----
 usr.sbin/ctladm/ctladm.c |  7 ++++---
 2 files changed, 32 insertions(+), 7 deletions(-)

diff --git a/usr.sbin/ctladm/ctladm.8 b/usr.sbin/ctladm/ctladm.8
index ba2712cb278c..4e7288dac6b6 100644
--- a/usr.sbin/ctladm/ctladm.8
+++ b/usr.sbin/ctladm/ctladm.8
@@ -35,7 +35,7 @@
 .\"
 .\" $Id: //depot/users/kenm/FreeBSD-test2/usr.sbin/ctladm/ctladm.8#3 $
 .\"
-.Dd December 27, 2023
+.Dd June 5, 2024
 .Dt CTLADM 8
 .Os
 .Sh NAME
@@ -162,6 +162,7 @@
 .Nm
 .Ic port
 .Op Fl c
+.Op Fl d Ar driver
 .Op Fl o Ar on|off
 .Op Fl w Ar wwpn
 .Op Fl W Ar wwnn
@@ -591,6 +592,10 @@ The serial number is returned when the error is injected.
 Perform one of several CTL frontend port operations.
 Either get a list of frontend ports
 .Pq Fl l ,
+create a new frontend port
+.Pq Fl c ,
+destroy a frontend port
+.Pq Fl r ,
 turn one or more frontends on
 or off
 .Pq Fl o Ar on|off ,
@@ -600,6 +605,8 @@ or World Wide Port Name
 .Pq Fl W Ar wwpn
 for a given port.
 One of
+.Fl c ,
+.Fl r ,
 .Fl l ,
 .Fl o ,
 or
@@ -612,6 +619,18 @@ combined with enabling/disabling or listing ports.
 .Bl -tag -width 12n
 .It Fl c
 Create new frontend port using free pp and vp=0.
+.It Fl d Ar driver
+Specify the name of the frontend driver used by the
+.Pq Fl c
+or
+.Pq Fl r
+subcommands.
+Valid driver names include
+.Dq ioctl ,
+.Dq iscsi ,
+and
+.Dq nvmf ,
+but more can be added by external kernel modules.
 .It Fl o Ar on|off
 Turn the specified CTL frontend ports on or off.
 If no port number or port type is specified, all ports are turned on or
@@ -626,7 +645,12 @@ The port numbers can be found in the frontend port list.
 Remove port specified with
 .Pq Fl p Ar targ_port .
 .It Fl t Ar fe_type
-Specify the frontend type.
+Specify the frontend type used by the
+.Pq Fl o ,
+.Pq Fl w ,
+and
+.Pq Fl W
+subcommands.
 Currently defined port types are
 .Dq fc
 (Fibre Channel),
@@ -640,7 +664,7 @@ and
 .It Fl w Ar wwnn
 Set the World Wide Node Name for the given port.
 The
-.Fl n
+.Fl p
 argument must be specified, since this is only possible to implement on a
 single port.
 As a general rule, the WWNN should be the same across all ports on the
@@ -648,7 +672,7 @@ system.
 .It Fl W Ar wwpn
 Set the World Wide Port Name for the given port.
 The
-.Fl n
+.Fl p
 argument must be specified, since this is only possible to implement on a
 single port.
 As a general rule, the WWPN must be different for every port in the system.
diff --git a/usr.sbin/ctladm/ctladm.c b/usr.sbin/ctladm/ctladm.c
index 1384daed74a2..1cf42aa5933b 100644
--- a/usr.sbin/ctladm/ctladm.c
+++ b/usr.sbin/ctladm/ctladm.c
@@ -541,7 +541,7 @@ cctl_port(int fd, int argc, char **argv, char *combinedopt)
 	 * we'll throw an error, since that only works on one port at a time.
 	 */
 	if ((port_type != CTL_PORT_NONE) && (targ_port != -1)) {
-		warnx("%s: can only specify one of -t or -n", __func__);
+		warnx("%s: can only specify one of -t or -p", __func__);
 		retval = 1;
 		goto bailout;
 	} else if ((targ_port == -1) && (port_type == CTL_PORT_NONE))
@@ -625,7 +625,7 @@ cctl_port(int fd, int argc, char **argv, char *combinedopt)
 	}
 	case CCTL_PORT_MODE_SET:
 		if (targ_port == -1) {
-			warnx("%s: -w and -W require -n", __func__);
+			warnx("%s: -w and -W require -p", __func__);
 			retval = 1;
 			goto bailout;
 		}
@@ -674,7 +674,8 @@ bailout:
 	return (retval);
 
 bailout_badarg:
-	warnx("%s: only one of -l, -o or -w/-W may be specified", __func__);
+	warnx("%s: only one of -c, -r, -l, -o or -w/-W may be specified",
+		__func__);
 	return (1);
 }