netdev - [PATCH] iproute2: trivial fix of ip link syntax in manpage

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]

Date:	Mon, 21 May 2012 13:58:50 +0200
From:	Andreas Henriksson <andreas@...al.se>
To:	Stephen Hemminger <shemminger@...tta.com>
Cc:	673171@...s.debian.org, netdev@...r.kernel.org
Subject: [PATCH] iproute2: trivial fix of ip link syntax in manpage

Ivan Vilata i Balaguer <ivan@...idor.net> wrote:
> Hi, I found that the description of the `ip link add` command in the manpage
> is outdated regarding the compulsory `link DEVICE` option.  For instance, `ip
> link help` says:
>
>     Usage: ip link add [link DEV] [ name ] NAME
>     ...
>
> But the manpage still says:
>
>     ip link add link DEVICE [ name ] NAME
>
> (Trying to provide a `link` option e.g. under an LXC container can frustrate
> the creation of dummy devices which don't need an actual device.)

The syntax of the "ip link help" output was fixed in commit
"iproute2: Fix usage and man page for 'ip link'" (a22e92951d).
This updates the manpage to mark "link DEVICE" as an optional
argument there as well.

http://bugs.debian.org/673171

Signed-off-by: Andreas Henriksson <andreas@...al.se>


diff --git a/man/man8/ip-link.8 b/man/man8/ip-link.8
index 72f4cfd..24d2ec7 100644
--- a/man/man8/ip-link.8
+++ b/man/man8/ip-link.8
@@ -23,7 +23,9 @@ ip-link \- network device configuration
 \fB\-o\fR[\fIneline\fR] }
 
 .ti -8
-.BI "ip link add link " DEVICE
+.BI "ip link add"
+.RB "[ " link
+.IR DEVICE " ]"
 .RB "[ " name " ]"
 .I NAME
 .br
--
To unsubscribe from this list: send the line "unsubscribe netdev" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html