netdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Andreas Henriksson <andreas@fatal.se>
To: Stephen Hemminger <shemminger@vyatta.com>
Cc: 673171@bugs.debian.org, netdev@vger.kernel.org
Subject: [PATCH v2] iproute2: trivial fix of ip link syntax in manpage
Date: Mon, 21 May 2012 15:48:06 +0200	[thread overview]
Message-ID: <20120521134806.GA29418@amd64.fatal.se> (raw)
In-Reply-To: <20120521115850.GA19151@amd64.fatal.se>

Argh.... template files and generated files also shipped.
Make sure to edit them both to avoid losing the change.

On Mon, May 21, 2012 at 01:58:50PM +0200, Andreas Henriksson wrote:
> Ivan Vilata i Balaguer <ivan@selidor.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@fatal.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
diff --git a/man/man8/ip-link.8.in b/man/man8/ip-link.8.in
index c4fa8c1..9386cc6 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

      reply	other threads:[~2012-05-21 13:45 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-05-21 11:58 Bug#673171: [PATCH] iproute2: trivial fix of ip link syntax in manpage Andreas Henriksson
2012-05-21 13:48 ` Andreas Henriksson [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=20120521134806.GA29418@amd64.fatal.se \
    --to=andreas@fatal.se \
    --cc=673171@bugs.debian.org \
    --cc=netdev@vger.kernel.org \
    --cc=shemminger@vyatta.com \
    /path/to/YOUR_REPLY

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

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).