public inbox for netdev@vger.kernel.org 
 help / color / mirror / Atom feed

From: Stephen Hemminger <stephen@networkplumber•org>
To: Witold Baryluk <witold.baryluk@gmail•com>
Cc: netdev@vger•kernel.org
Subject: Re: Incorrect --help / manpage for -color for ip, tc, bridge
Date: Mon, 14 Dec 2020 08:00:13 -0800	[thread overview]
Message-ID: <20201214080013.6ef78cb7@hermes.local> (raw)
In-Reply-To: <CAEGMnwozvs0Fn0R-aQBpbN2HY9v7PNmUN=FGL=H8TgDYLAU1ow@mail.gmail.com>

On Sat, 12 Dec 2020 20:07:16 +0000
Witold Baryluk <witold.baryluk@gmail•com> wrote:

> iproute 5.9.0
> 
> Apparently ip -c is a shortcut to ip -color
> 
> but in tc, tc -c doesn't work, one needs to say tc -col or tc -color
> 
> I understand there is tc -conf, which has tc -c.
> 
> But:
> 
> Help says:
> 
> root@debian:~# tc
> Usage:    tc [ OPTIONS ] OBJECT { COMMAND | help }
>     tc [-force] -batch filename
> where  OBJECT := { qdisc | class | filter | chain |
>             action | monitor | exec }
>        OPTIONS := { -V[ersion] | -s[tatistics] | -d[etails] | -r[aw] |
>             -o[neline] | -j[son] | -p[retty] | -c[olor]
>             -b[atch] [filename] | -n[etns] name | -N[umeric] |
>              -nm | -nam[es] | { -cf | -conf } path }
> 
> this should be:
> 
> root@debian:~# tc
> Usage:    tc [ OPTIONS ] OBJECT { COMMAND | help }
>     tc [-force] -batch filename
> where  OBJECT := { qdisc | class | filter | chain |
>             action | monitor | exec }
>        OPTIONS := { -V[ersion] | -s[tatistics] | -d[etails] | -r[aw] |
>             -o[neline] | -j[son] | -p[retty] | -col[or]
>             -b[atch] [filename] | -n[etns] name | -N[umeric] |
>              -nm | -nam[es] | { -cf | -c[onf] } path }
> 
> 
> ( -c[olor] -> -col[or] )  # also in --help for ip and bridge
> 
> If only -c meaning -conf could be removed, it would be even nicer. -cf
> is already short.
> 
> Additionally in manpage for tc, ip and bridge:
>        -c[color][={always|auto|never}
>               Configure color output. If parameter is omitted or
> always, color output is enabled regardless of stdout state. If
> parameter is auto, stdout is checked to be a terminal be‐
>               fore  enabling  color output. If parameter is never,
> color output is disabled. If specified multiple times, the last one
> takes precedence. This flag is ignored if -json is
>               also given.
> 
> 
> 
> I don't think this is correct either.
> 
> Should be -col[or], not -c[color] (sic!).
> 
> Similar mistakes are in man pages and --help messages also for ip,
> bridge, not just tc.
> 
> 
> Regards,
> Witold

Send a patch to fix it.

     prev parent reply	other threads:[~2020-12-14 16:01 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-12-12 20:07 Incorrect --help / manpage for -color for ip, tc, bridge Witold Baryluk
2020-12-14 16:00 ` Stephen Hemminger [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20201214080013.6ef78cb7@hermes.local \
    --to=stephen@networkplumber$(echo .)org \
    --cc=netdev@vger$(echo .)kernel.org \
    --cc=witold.baryluk@gmail$(echo .)com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox