From: Andreas Henriksson <andreas@fatal.se>
Date: Mon, 21 May 2012 13:48:06 +0000 (+0200)
Subject: iproute2: trivial fix of ip link syntax in manpage
X-Git-Tag: v3.4.0~1
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=9fc56974acc5bef7a2bb0d0402c74f5d7cf6b3d5;p=thirdparty%2Fiproute2.git

iproute2: trivial fix of ip link syntax in manpage

Reported by Ivan Vilata i Balaguer <ivan@selidor.net>
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@fatal.se>
---

diff --git a/man/man8/ip-link.8 b/man/man8/ip-link.8
index 72f4cfd68..24d2ec78f 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
diff --git a/man/man8/ip-link.8.in b/man/man8/ip-link.8.in
index c4fa8c1ad..9386cc648 100644
--- a/man/man8/ip-link.8.in
+++ b/man/man8/ip-link.8.in
@@ -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