netdev - Re: [PATCH] ip: Add examples to usage help

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]

Message-ID: <20240211130014.2a35e179@hermes.local>
Date: Sun, 11 Feb 2024 13:00:14 -0800
From: Stephen Hemminger <stephen@...workplumber.org>
To: Yedaya Katsman <yedaya.ka@...il.com>
Cc: netdev@...r.kernel.org
Subject: Re: [PATCH] ip: Add examples to usage help

On Sun, 11 Feb 2024 19:57:04 +0200
Yedaya Katsman <yedaya.ka@...il.com> wrote:

> Currently the usage only shows the syntax with all possible options,
> which makes writing the most frequently used commands cumbersome, since it
> requires parsing the syntax in your head. This praticularly affects
> users new to the command, that resort to reading man pages or search
> engines in order to find the correct invocations.
> 
> Copy over the examples from the man page, with the same indentation
> for the command exaplanations that exist there. I removed the second
> link example to save space.
> 
> The whole section is indented the same way the other sections in the usage
> are, to keep the uniformity.
> 
> Signed-off-by: Yedaya Katsman <yedaya.ka@...il.com>

No.
Examples belong on man page, not the help message.
Help should be short and concise.