diff mbox

[iproute2,1/1] tc: updated man page to reflect handle-id use in filter GET command.

Message ID 1480623644-27533-1-git-send-email-mrv@mojatatu.com
State Changes Requested, archived
Delegated to: stephen hemminger
Headers show

Commit Message

Roman Mashak Dec. 1, 2016, 8:20 p.m. UTC
Signed-off-by: Roman Mashak <mrv@mojatatu.com>
---
 man/man8/tc.8 | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

Comments

Stephen Hemminger Dec. 2, 2016, 10:06 p.m. UTC | #1
On Thu,  1 Dec 2016 15:20:44 -0500
Roman Mashak <mrv@mojatatu.com> wrote:

> Signed-off-by: Roman Mashak <mrv@mojatatu.com>
> ---
>  man/man8/tc.8 | 6 ++++--
>  1 file changed, 4 insertions(+), 2 deletions(-)
> 
> diff --git a/man/man8/tc.8 b/man/man8/tc.8
> index 8a47a2b..d957ffa 100644
> --- a/man/man8/tc.8
> +++ b/man/man8/tc.8
> @@ -32,7 +32,9 @@ class-id ] qdisc
>  DEV
>  .B [ parent
>  qdisc-id
> -.B | root ] protocol
> +.B | root ] [ handle
> +handle-id ]
> +.B protocol
>  protocol
>  .B prio
>  priority filtertype
> @@ -577,7 +579,7 @@ it is created.
>  
>  .TP
>  get
> -Displays a single filter given the interface, parent ID, priority, protocol and handle ID.
> +Displays a single filter given the interface, qdisc-id, priority, protocol and handle-id.
>  
>  .TP
>  show

The proper syntax for man page usage section is to put keywords in bold and any value
that is variable in italic.

I know this whole man page doesn't do this correctly. But that doesn't mean that new
additions should continue with the mistake.

Please revise and resubmit. Extra bonus points for fixing the other bits.
Phil Sutter Dec. 5, 2016, 11:07 a.m. UTC | #2
On Fri, Dec 02, 2016 at 02:06:22PM -0800, Stephen Hemminger wrote:
> On Thu,  1 Dec 2016 15:20:44 -0500
> Roman Mashak <mrv@mojatatu.com> wrote:
> 
> > Signed-off-by: Roman Mashak <mrv@mojatatu.com>
> > ---
> >  man/man8/tc.8 | 6 ++++--
> >  1 file changed, 4 insertions(+), 2 deletions(-)
> > 
> > diff --git a/man/man8/tc.8 b/man/man8/tc.8
> > index 8a47a2b..d957ffa 100644
> > --- a/man/man8/tc.8
> > +++ b/man/man8/tc.8
> > @@ -32,7 +32,9 @@ class-id ] qdisc
> >  DEV
> >  .B [ parent
> >  qdisc-id
> > -.B | root ] protocol
> > +.B | root ] [ handle
> > +handle-id ]
> > +.B protocol
> >  protocol
> >  .B prio
> >  priority filtertype
> > @@ -577,7 +579,7 @@ it is created.
> >  
> >  .TP
> >  get
> > -Displays a single filter given the interface, parent ID, priority, protocol and handle ID.
> > +Displays a single filter given the interface, qdisc-id, priority, protocol and handle-id.
> >  
> >  .TP
> >  show
> 
> The proper syntax for man page usage section is to put keywords in bold and any value
> that is variable in italic.
> 
> I know this whole man page doesn't do this correctly. But that doesn't mean that new
> additions should continue with the mistake.
> 
> Please revise and resubmit. Extra bonus points for fixing the other bits.

+1! Thanks for playing man page style Nazi^Wguardian. :)

Cheers, Phil
diff mbox

Patch

diff --git a/man/man8/tc.8 b/man/man8/tc.8
index 8a47a2b..d957ffa 100644
--- a/man/man8/tc.8
+++ b/man/man8/tc.8
@@ -32,7 +32,9 @@  class-id ] qdisc
 DEV
 .B [ parent
 qdisc-id
-.B | root ] protocol
+.B | root ] [ handle
+handle-id ]
+.B protocol
 protocol
 .B prio
 priority filtertype
@@ -577,7 +579,7 @@  it is created.
 
 .TP
 get
-Displays a single filter given the interface, parent ID, priority, protocol and handle ID.
+Displays a single filter given the interface, qdisc-id, priority, protocol and handle-id.
 
 .TP
 show