netdev - [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-next>] [day] [month] [year] [list]

Message-Id: <20240211175704.5963-1-yedaya.ka@gmail.com>
Date: Sun, 11 Feb 2024 19:57:04 +0200
From: Yedaya Katsman <yedaya.ka@...il.com>
To: netdev@...r.kernel.org
Cc: Stephen Hemminger <stephen@...workplumber.org>,
	Yedaya Katsman <yedaya.ka@...il.com>
Subject: [PATCH] ip: Add examples to usage help

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>
---
 ip/ip.c | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/ip/ip.c b/ip/ip.c
index e51fa206d282..78c3f130c593 100644
--- a/ip/ip.c
+++ b/ip/ip.c
@@ -73,7 +73,16 @@ static void usage(void)
 		"                    -l[oops] { maximum-addr-flush-attempts } | -echo | -br[ief] |\n"
 		"                    -o[neline] | -t[imestamp] | -ts[hort] | -b[atch] [filename] |\n"
 		"                    -rc[vbuf] [size] | -n[etns] name | -N[umeric] | -a[ll] |\n"
-		"                    -c[olor]}\n");
+		"                    -c[olor]}\n"
+		"Examples: ip addr\n"
+		"              Shows addresses assigned to all network interfaces.\n"
+		"          ip neigh\n"
+		"              Shows the current neighbour table in kernel.\n"
+		"          ip link set x up\n"
+		"              Bring up interface x.\n"
+		"          ip route\n"
+		"              Show table routes.\n"
+		);
 	exit(-1);
 }

-- 
2.34.1