netdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH iproute2 1/1] tc: updated man page to reflect handle-id use in filter GET command.
@ 2016-12-01 20:20 Roman Mashak
  2016-12-02 22:06 ` Stephen Hemminger
  0 siblings, 1 reply; 3+ messages in thread
From: Roman Mashak @ 2016-12-01 20:20 UTC (permalink / raw)
  To: stephen; +Cc: netdev, sathya.perla, Roman Mashak

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
-- 
1.9.1

^ permalink raw reply related	[flat|nested] 3+ messages in thread

* Re: [PATCH iproute2 1/1] tc: updated man page to reflect handle-id use in filter GET command.
  2016-12-01 20:20 [PATCH iproute2 1/1] tc: updated man page to reflect handle-id use in filter GET command Roman Mashak
@ 2016-12-02 22:06 ` Stephen Hemminger
  2016-12-05 11:07   ` Phil Sutter
  0 siblings, 1 reply; 3+ messages in thread
From: Stephen Hemminger @ 2016-12-02 22:06 UTC (permalink / raw)
  To: Roman Mashak; +Cc: netdev, sathya.perla

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.

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH iproute2 1/1] tc: updated man page to reflect handle-id use in filter GET command.
  2016-12-02 22:06 ` Stephen Hemminger
@ 2016-12-05 11:07   ` Phil Sutter
  0 siblings, 0 replies; 3+ messages in thread
From: Phil Sutter @ 2016-12-05 11:07 UTC (permalink / raw)
  To: Stephen Hemminger; +Cc: Roman Mashak, netdev, sathya.perla

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

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2016-12-05 11:07 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2016-12-01 20:20 [PATCH iproute2 1/1] tc: updated man page to reflect handle-id use in filter GET command Roman Mashak
2016-12-02 22:06 ` Stephen Hemminger
2016-12-05 11:07   ` Phil Sutter

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).