matthias
/
iproute2
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

man: devlink-port: fix style 

Values should be .I, square brackets should be used for optional values,
curly brackets for lists. Follow this in the devlink-port man page.

Signed-off-by: Antoine Tenart <atenart@kernel.org>
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
This commit is contained in:
Antoine Tenart 2021-10-06 11:44:54 +02:00 committed by Stephen Hemminger
parent 14802d84d3
commit 04ee8e6f06
1 changed files with 19 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
man/man8/devlink-port.8
View File

@ -45,16 +45,16 @@ devlink-port \- devlink port configuration
.ti -8 .ti -8
.BI "devlink port add" .BI "devlink port add"
.RB "[" .RB "{"
.IR "DEV | DEV/PORT_INDEX" .IR "DEV | DEV/PORT_INDEX"
.RB "] " .RB "} "
.RB "[ " flavour .RB "[ " flavour
.IR FLAVOUR " ]" .IR FLAVOUR " ]"
.RB "[ " pcipf .RB "[ " pcipf
.IR PFNUMBER " ]" .IR PFNUMBER " ]"
.br .br
.RB "{ " sfnum .RB "[ " sfnum
.IR SFNUMBER " }" .IR SFNUMBER " ]"
.br .br
.RB "[ " controller .RB "[ " controller
.IR CNUM " ]" .IR CNUM " ]"
@ -102,7 +102,7 @@ devlink-port \- devlink port configuration
.SS devlink port set - change devlink port attributes .SS devlink port set - change devlink port attributes
.PP .PP
.B "DEV/PORT_INDEX" .I "DEV/PORT_INDEX"
- specifies the devlink port to operate on. - specifies the devlink port to operate on.
.in +4 .in +4
@ -126,7 +126,7 @@ set port type
.SS devlink port split - split devlink port into more .SS devlink port split - split devlink port into more
.PP .PP
.B "DEV/PORT_INDEX" .I "DEV/PORT_INDEX"
- specifies the devlink port to operate on. - specifies the devlink port to operate on.
.TP .TP
@ -137,7 +137,7 @@ number of ports to split to.
Could be performed on any split port of the same split group. Could be performed on any split port of the same split group.
.PP .PP
.B "DEV/PORT_INDEX" .I "DEV/PORT_INDEX"
- specifies the devlink port to operate on. - specifies the devlink port to operate on.
.SS devlink port show - display devlink port attributes .SS devlink port show - display devlink port attributes
@ -154,11 +154,11 @@ Is an alias for
.ti -8 .ti -8
.SS devlink port add - add a devlink port .SS devlink port add - add a devlink port
.PP .PP
.B "DEV" .I "DEV"
- specifies the devlink device to operate on. or - specifies the devlink device to operate on. or
.PP .PP
.B "DEV/PORT_INDEX" .I "DEV/PORT_INDEX"
- specifies the devlink port index to use for the requested new port. - specifies the devlink port index to use for the requested new port.
This is optional. When omitted, driver allocates unique port index. This is optional. When omitted, driver allocates unique port index.
@ -173,17 +173,17 @@ set port flavour
- PCI SF port - PCI SF port
.TP .TP
.BR pfnum " { " pfnumber " } " .BI pfnum " PFNUMBER "
Specifies PCI pfnumber to use on which a SF device to create Specifies PCI pfnumber to use on which a SF device to create
.TP .TP
.BR sfnum " { " sfnumber " } " .BI sfnum " SFNUMBER "
Specifies sfnumber to assign to the device of the SF. Specifies sfnumber to assign to the device of the SF.
This field is optional for those devices which supports auto assignment of the This field is optional for those devices which supports auto assignment of the
SF number. SF number.
.TP .TP
.BR controller " { " controller " } " .BI controller " CNUM "
Specifies controller number for which the SF port is created. Specifies controller number for which the SF port is created.
This field is optional. It is used only when SF port is created for the This field is optional. It is used only when SF port is created for the
external controller. external controller.
@ -192,17 +192,17 @@ external controller.
.SS devlink port function set - Set the port function attribute(s). .SS devlink port function set - Set the port function attribute(s).
.PP .PP
.B "DEV/PORT_INDEX" .I "DEV/PORT_INDEX"
- specifies the devlink port to operate on. - specifies the devlink port to operate on.
.TP .TP
.BR hw_addr " ADDR" .BI hw_addr " ADDR"
- hardware address of the function to set. This is a Ethernet MAC address when Hardware address of the function to set. This is a Ethernet MAC address when
port type is Ethernet. port type is Ethernet.
.TP .TP
.BR state " { " active " | " inactive " } " .BR state " { " active " | " inactive " } "
- new state of the function to change to. New state of the function to change to.
.I active .I active
- Once configuration of the function is done, activate the function. - Once configuration of the function is done, activate the function.
@ -213,13 +213,13 @@ port type is Ethernet.
.ti -8 .ti -8
.SS devlink port del - delete a devlink port .SS devlink port del - delete a devlink port
.PP .PP
.B "DEV/PORT_INDEX" .I "DEV/PORT_INDEX"
- specifies the devlink port to delete. - specifies the devlink port to delete.
.ti -8 .ti -8
.SS devlink port param set - set new value to devlink port configuration parameter .SS devlink port param set - set new value to devlink port configuration parameter
.PP .PP
.B "DEV/PORT_INDEX" .I "DEV/PORT_INDEX"
- specifies the devlink port to operate on. - specifies the devlink port to operate on.
.TP .TP
@ -246,7 +246,7 @@ Configuration mode in which the new value is set.
.SS devlink port param show - display devlink port supported configuration parameters attributes .SS devlink port param show - display devlink port supported configuration parameters attributes
.PP .PP
.B "DEV/PORT_INDEX" .I "DEV/PORT_INDEX"
- specifies the devlink port to operate on. - specifies the devlink port to operate on.
.B name .B name