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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Date:   Mon, 5 Dec 2016 12:07:20 +0100
From:   Phil Sutter <phil@....cc>
To:     Stephen Hemminger <stephen@...workplumber.org>
Cc:     Roman Mashak <mrv@...atatu.com>, netdev@...r.kernel.org,
        sathya.perla@...adcom.com
Subject: Re: [PATCH iproute2 1/1] tc: updated man page to reflect handle-id
 use in filter GET command.

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@...atatu.com> wrote:
> 
> > Signed-off-by: Roman Mashak <mrv@...atatu.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