diff mbox series

[iproute2-next,9/9] man: dcb-app: clean up a few mistakes

Message ID 20230510-dcb-rewr-v1-9-83adc1f93356@microchip.com (mailing list archive)
State Superseded
Delegated to: David Ahern
Headers show
Series Introduce new dcb-rewr subcommand | expand

Checks

Context Check Description
netdev/tree_selection success Not a local patch

Commit Message

Daniel Machon May 22, 2023, 6:41 p.m. UTC
While referencing the dcb-app manpage, I spotted a few mistakes. Lets
fix them.

Signed-off-by: Daniel Machon <daniel.machon@microchip.com>
---
 man/man8/dcb-app.8 | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

Comments

Petr Machata May 23, 2023, 4:49 p.m. UTC | #1
Daniel Machon <daniel.machon@microchip.com> writes:

> While referencing the dcb-app manpage, I spotted a few mistakes. Lets
> fix them.
>
> Signed-off-by: Daniel Machon <daniel.machon@microchip.com>
> ---
>  man/man8/dcb-app.8 | 10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)
>
> diff --git a/man/man8/dcb-app.8 b/man/man8/dcb-app.8
> index ecb38591168e..ebec67c90801 100644
> --- a/man/man8/dcb-app.8
> +++ b/man/man8/dcb-app.8
> @@ -1,4 +1,4 @@
> -.TH DCB-ETS 8 "6 December 2020" "iproute2" "Linux"
> +.TH DCB-APP 8 "6 December 2020" "iproute2" "Linux"
>  .SH NAME
>  dcb-app \- show / manipulate application priority table of
>  the DCB (Data Center Bridging) subsystem
> @@ -26,7 +26,7 @@ the DCB (Data Center Bridging) subsystem
>  .RB "[ " pcp-prio " ]"
>  
>  .ti -8
> -.B dcb ets " { " add " | " del " | " replace " } " dev
> +.B dcb app " { " add " | " del " | " replace " } " dev
>  .RI DEV
>  .RB "[ " default-prio " " \fIPRIO-LIST\fB " ]"
>  .RB "[ " ethtype-prio " " \fIET-MAP\fB " ]"
> @@ -106,7 +106,7 @@ individual APP 3-tuples through
>  .B add
>  and
>  .B del
> -commands. On the other other hand, the command
> +commands. On the other hand, the command

Heh, neat typo.

>  .B replace
>  does what one would typically want in this situation--first adds the new
>  configuration, and then removes the obsolete one, so that only one
> @@ -184,7 +184,7 @@ for details. Keys are DSCP points, values are priorities assigned to
>  traffic with matching DSCP. DSCP points can be written either directly as
>  numeric values, or using symbolic names specified in
>  .B /etc/iproute2/rt_dsfield
> -(however note that that file specifies full 8-bit dsfield values, whereas
> +(however note that file specifies full 8-bit dsfield values, whereas

Nope, this one's correct. The first that is a conjunction, the second
one... a pronoun? Not sure.

Maybe make it "note that the file"? It's clear what file we are talking
about and the grating "that that" goes away. Pretty sure it's a
stylistic faux pas.

>  .B dcb app
>  will only use the higher six bits).
>  .B dcb app show
> @@ -230,7 +230,7 @@ priority 4:
>  .P
>  # dcb app replace dev eth0 dscp-prio 24:4
>  .br
> -# dcb app show dev eth0 dscp-prio
> +# dcb app -N show dev eth0 dscp-prio
>  .br
>  dscp-prio 0:0 24:4 48:6
Daniel Machon May 24, 2023, 6:56 a.m. UTC | #2
> Daniel Machon <daniel.machon@microchip.com> writes:
> 
> > While referencing the dcb-app manpage, I spotted a few mistakes. Lets
> > fix them.
> >
> > Signed-off-by: Daniel Machon <daniel.machon@microchip.com>
> > ---
> >  man/man8/dcb-app.8 | 10 +++++-----
> >  1 file changed, 5 insertions(+), 5 deletions(-)
> >
> > diff --git a/man/man8/dcb-app.8 b/man/man8/dcb-app.8
> > index ecb38591168e..ebec67c90801 100644
> > --- a/man/man8/dcb-app.8
> > +++ b/man/man8/dcb-app.8
> > @@ -1,4 +1,4 @@
> > -.TH DCB-ETS 8 "6 December 2020" "iproute2" "Linux"
> > +.TH DCB-APP 8 "6 December 2020" "iproute2" "Linux"
> >  .SH NAME
> >  dcb-app \- show / manipulate application priority table of
> >  the DCB (Data Center Bridging) subsystem
> > @@ -26,7 +26,7 @@ the DCB (Data Center Bridging) subsystem
> >  .RB "[ " pcp-prio " ]"
> >
> >  .ti -8
> > -.B dcb ets " { " add " | " del " | " replace " } " dev
> > +.B dcb app " { " add " | " del " | " replace " } " dev
> >  .RI DEV
> >  .RB "[ " default-prio " " \fIPRIO-LIST\fB " ]"
> >  .RB "[ " ethtype-prio " " \fIET-MAP\fB " ]"
> > @@ -106,7 +106,7 @@ individual APP 3-tuples through
> >  .B add
> >  and
> >  .B del
> > -commands. On the other other hand, the command
> > +commands. On the other hand, the command
> 
> Heh, neat typo.

Liked that one too.

> 
> >  .B replace
> >  does what one would typically want in this situation--first adds the new
> >  configuration, and then removes the obsolete one, so that only one
> > @@ -184,7 +184,7 @@ for details. Keys are DSCP points, values are priorities assigned to
> >  traffic with matching DSCP. DSCP points can be written either directly as
> >  numeric values, or using symbolic names specified in
> >  .B /etc/iproute2/rt_dsfield
> > -(however note that that file specifies full 8-bit dsfield values, whereas
> > +(however note that file specifies full 8-bit dsfield values, whereas
> 
> Nope, this one's correct. The first that is a conjunction, the second
> one... a pronoun? Not sure.

Argh. You are right. Will change it here and in dcb-rewr.8 too.

> 
> Maybe make it "note that the file"? It's clear what file we are talking
> about and the grating "that that" goes away. Pretty sure it's a
> stylistic faux pas.

> 
> >  .B dcb app
> >  will only use the higher six bits).
> >  .B dcb app show
> > @@ -230,7 +230,7 @@ priority 4:
> >  .P
> >  # dcb app replace dev eth0 dscp-prio 24:4
> >  .br
> > -# dcb app show dev eth0 dscp-prio
> > +# dcb app -N show dev eth0 dscp-prio
> >  .br
> >  dscp-prio 0:0 24:4 48:6
>
diff mbox series

Patch

diff --git a/man/man8/dcb-app.8 b/man/man8/dcb-app.8
index ecb38591168e..ebec67c90801 100644
--- a/man/man8/dcb-app.8
+++ b/man/man8/dcb-app.8
@@ -1,4 +1,4 @@ 
-.TH DCB-ETS 8 "6 December 2020" "iproute2" "Linux"
+.TH DCB-APP 8 "6 December 2020" "iproute2" "Linux"
 .SH NAME
 dcb-app \- show / manipulate application priority table of
 the DCB (Data Center Bridging) subsystem
@@ -26,7 +26,7 @@  the DCB (Data Center Bridging) subsystem
 .RB "[ " pcp-prio " ]"
 
 .ti -8
-.B dcb ets " { " add " | " del " | " replace " } " dev
+.B dcb app " { " add " | " del " | " replace " } " dev
 .RI DEV
 .RB "[ " default-prio " " \fIPRIO-LIST\fB " ]"
 .RB "[ " ethtype-prio " " \fIET-MAP\fB " ]"
@@ -106,7 +106,7 @@  individual APP 3-tuples through
 .B add
 and
 .B del
-commands. On the other other hand, the command
+commands. On the other hand, the command
 .B replace
 does what one would typically want in this situation--first adds the new
 configuration, and then removes the obsolete one, so that only one
@@ -184,7 +184,7 @@  for details. Keys are DSCP points, values are priorities assigned to
 traffic with matching DSCP. DSCP points can be written either directly as
 numeric values, or using symbolic names specified in
 .B /etc/iproute2/rt_dsfield
-(however note that that file specifies full 8-bit dsfield values, whereas
+(however note that file specifies full 8-bit dsfield values, whereas
 .B dcb app
 will only use the higher six bits).
 .B dcb app show
@@ -230,7 +230,7 @@  priority 4:
 .P
 # dcb app replace dev eth0 dscp-prio 24:4
 .br
-# dcb app show dev eth0 dscp-prio
+# dcb app -N show dev eth0 dscp-prio
 .br
 dscp-prio 0:0 24:4 48:6