netdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Phil Sutter <phil@nwl.cc>
To: Stephen Hemminger <shemming@brocade.com>
Cc: netdev@vger.kernel.org
Subject: [iproute PATCH 20/20] man: ip-*.8: drop any reference to generic ip options
Date: Wed, 24 Feb 2016 09:21:33 +0100	[thread overview]
Message-ID: <1456302093-697-21-git-send-email-phil@nwl.cc> (raw)
In-Reply-To: <1456302093-697-1-git-send-email-phil@nwl.cc>

Listing generic 'ip' options in subcommand man pages is redundant and
error-prone, as they won't be kept in sync anyway. Since many other man
pages don't list them either, drop references to them in the remaining
ones.

Signed-off-by: Phil Sutter <phil@nwl.cc>
---
 man/man8/ip-addrlabel.8 | 14 +-------------
 man/man8/ip-link.8.in   | 15 +--------------
 man/man8/ip-monitor.8   |  4 +---
 man/man8/ip-mroute.8    |  2 +-
 4 files changed, 4 insertions(+), 31 deletions(-)

diff --git a/man/man8/ip-addrlabel.8 b/man/man8/ip-addrlabel.8
index 51ef5727a0db1..233d6067ab407 100644
--- a/man/man8/ip-addrlabel.8
+++ b/man/man8/ip-addrlabel.8
@@ -6,21 +6,9 @@ ip-addrlabel \- protocol address label management
 .ad l
 .in +8
 .ti -8
-.B ip
-.RI "[ " OPTIONS " ]"
-.B addrlabel
+.B ip addrlabel
 .RI " { " COMMAND " | "
 .BR help " }"
-.sp
-
-.ti -8
-.IR OPTIONS " := { "
-\fB\-V\fR[\fIersion\fR] |
-\fB\-s\fR[\fItatistics\fR] |
-\fB\-r\fR[\fIesolve\fR] |
-\fB\-f\fR[\fIamily\fR] {
-.BR inet " | " inet6 " | " ipx " | " dnet " | " link " } | "
-\fB\-o\fR[\fIneline\fR] }
 
 .ti -8
 .BR "ip addrlabel" " { " add " | " del " } " prefix
diff --git a/man/man8/ip-link.8.in b/man/man8/ip-link.8.in
index cc0842f01ab59..82670bcd9a9c1 100644
--- a/man/man8/ip-link.8.in
+++ b/man/man8/ip-link.8.in
@@ -6,25 +6,12 @@ ip-link \- network device configuration
 .ad l
 .in +8
 .ti -8
-.B ip
-.RI "[ " OPTIONS " ]"
-.B link
+.B ip link
 .RI  " { " COMMAND " | "
 .BR help " }"
 .sp
 
 .ti -8
-.IR OPTIONS " := { "
-\fB\-V\fR[\fIersion\fR] |
-\fB\-h\fR[\fIuman-readable\fR] |
-\fB\-s\fR[\fItatistics\fR] |
-\fB\-r\fR[\fIesolve\fR] |
-\fB\-f\fR[\fIamily\fR] {
-.BR inet " | " inet6 " | " ipx " | " dnet " | " link " } | "
-\fB\-o\fR[\fIneline\fR] |
-\fB\-br\fR[\fIief\fR] }
-
-.ti -8
 .BI "ip link add"
 .RB "[ " link
 .IR DEVICE " ]"
diff --git a/man/man8/ip-monitor.8 b/man/man8/ip-monitor.8
index d2bd381a8c32e..86f8f9885fefe 100644
--- a/man/man8/ip-monitor.8
+++ b/man/man8/ip-monitor.8
@@ -6,9 +6,7 @@ ip-monitor, rtmon \- state monitoring
 .ad l
 .in +8
 .ti -8
-.BR "ip " " [ "
-.IR ip-OPTIONS " ]"
-.BR  "monitor" " [ " all " |"
+.BR "ip monitor" " [ " all " |"
 .IR OBJECT-LIST " ] ["
 .BI file " FILENAME "
 ] [
diff --git a/man/man8/ip-mroute.8 b/man/man8/ip-mroute.8
index e89b6b2d2cc56..b64e30d33d412 100644
--- a/man/man8/ip-mroute.8
+++ b/man/man8/ip-mroute.8
@@ -6,7 +6,7 @@ ip-mroute \- multicast routing cache management
 .ad l
 .in +8
 .ti -8
-.BR "ip " " [ ip-OPTIONS ] " "mroute show" " [ [ "
+.BR "ip mroute show" " [ [ "
 .BR " to " " ] "
 .IR PREFIX " ] [ "
 .B  from
-- 
2.6.4

  parent reply	other threads:[~2016-02-24  8:22 UTC|newest]

Thread overview: 47+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-02-24  8:21 [iproute PATCH 00/20] Sync man pages and help texts Phil Sutter
2016-02-24  8:21 ` [iproute PATCH 01/20] ip: align help text with manpage Phil Sutter
2016-02-24  8:21 ` [iproute PATCH 02/20] ipaddrlabel: Improve help text precision Phil Sutter
2016-02-24  8:21 ` [iproute PATCH 03/20] iplink: fix help text syntax Phil Sutter
2016-03-02 17:38   ` Stephen Hemminger
2016-03-02 18:19     ` [iproute PATCH v2 00/20] Sync man pages and help texts Phil Sutter
2016-03-02 18:19       ` [iproute PATCH v2 01/20] ip: align help text with manpage Phil Sutter
2016-03-02 18:19       ` [iproute PATCH v2 02/20] ipaddrlabel: Improve help text precision Phil Sutter
2016-03-02 18:19       ` [iproute PATCH v2 03/20] iplink: fix help text syntax Phil Sutter
2016-03-02 18:19       ` [iproute PATCH v2 04/20] ipneigh: add missing proxy keyword to help text Phil Sutter
2016-03-02 18:19       ` [iproute PATCH v2 05/20] ipntable: Fix typo in " Phil Sutter
2016-03-02 18:19       ` [iproute PATCH v2 06/20] iproute: TYPE keyword is not optional, fix help text accordingly Phil Sutter
2016-03-03 14:21         ` Jamal Hadi Salim
2016-03-03 15:05           ` Phil Sutter
2016-03-07 11:23             ` Jamal Hadi Salim
2016-03-02 18:19       ` [iproute PATCH v2 07/20] iprule: add missing nat keyword to help text Phil Sutter
2016-03-02 18:19       ` [iproute PATCH v2 08/20] man: ip-address.8: Minor syntax fixes Phil Sutter
2016-03-02 18:19       ` [iproute PATCH v2 09/20] man: ip-link.8: minor font fix Phil Sutter
2016-03-02 18:19       ` [iproute PATCH v2 10/20] man: ip-link.8: Fix and improve synopsis Phil Sutter
2016-03-02 18:19       ` [iproute PATCH v2 11/20] man: ip-neighbour: Fix for missing NUD_STATE description Phil Sutter
2016-03-02 18:20       ` [iproute PATCH v2 12/20] man: ip-netns.8: Clarify synopsis a bit Phil Sutter
2016-03-02 18:20       ` [iproute PATCH v2 13/20] man: ip-ntable.8: Review synopsis section Phil Sutter
2016-03-02 18:20       ` [iproute PATCH v2 14/20] man: ip-rule.8: " Phil Sutter
2016-03-02 18:20       ` [iproute PATCH v2 15/20] man: ip-token.8: " Phil Sutter
2016-03-02 18:20       ` [iproute PATCH v2 16/20] man: ip-tunnel.8: Document missing 6rd action Phil Sutter
2016-03-02 18:20       ` [iproute PATCH v2 17/20] man: ip-xfrm.8: Document missing parameters Phil Sutter
2016-03-02 18:20       ` [iproute PATCH v2 18/20] man: ip.8: Add missing flags and token subcommand description Phil Sutter
2016-03-02 18:20       ` [iproute PATCH v2 19/20] man: ip-l2tp.8: Fix BNF syntax Phil Sutter
2016-03-02 18:20       ` [iproute PATCH v2 20/20] man: ip-*.8: drop any reference to generic ip options Phil Sutter
2016-02-24  8:21 ` [iproute PATCH 04/20] ipneigh: add missing proxy keyword to help text Phil Sutter
2016-02-24  8:21 ` [iproute PATCH 05/20] ipntable: Fix typo in " Phil Sutter
2016-02-24  8:21 ` [iproute PATCH 06/20] iproute: TYPE keyword is not optional, fix help text accordingly Phil Sutter
2016-02-24  8:21 ` [iproute PATCH 07/20] iprule: add missing nat keyword to help text Phil Sutter
2016-02-24  8:21 ` [iproute PATCH 08/20] man: ip-address.8: Minor syntax fixes Phil Sutter
2016-02-24  8:21 ` [iproute PATCH 09/20] man: ip-link.8: minor font fix Phil Sutter
2016-02-24  8:21 ` [iproute PATCH 10/20] man: ip-link.8: Fix and improve synopsis Phil Sutter
2016-02-24  8:21 ` [iproute PATCH 11/20] man: ip-neighbour: Fix for missing NUD_STATE description Phil Sutter
2016-02-24  8:21 ` [iproute PATCH 12/20] man: ip-netns.8: Clarify synopsis a bit Phil Sutter
2016-02-24  8:21 ` [iproute PATCH 13/20] man: ip-ntable.8: Review synopsis section Phil Sutter
2016-02-24  8:21 ` [iproute PATCH 14/20] man: ip-rule.8: " Phil Sutter
2016-02-24  8:21 ` [iproute PATCH 15/20] man: ip-token.8: " Phil Sutter
2016-02-24  8:21 ` [iproute PATCH 16/20] man: ip-tunnel.8: Document missing 6rd action Phil Sutter
2016-02-24  8:21 ` [iproute PATCH 17/20] man: ip-xfrm.8: Document missing parameters Phil Sutter
2016-02-24  8:21 ` [iproute PATCH 18/20] man: ip.8: Add missing flags and token subcommand description Phil Sutter
2016-02-24  8:21 ` [iproute PATCH 19/20] man: ip-l2tp.8: Fix BNF syntax Phil Sutter
2016-02-24  8:21 ` Phil Sutter [this message]
2016-03-02 19:59 ` [iproute PATCH 00/20] Sync man pages and help texts Stephen Hemminger

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=1456302093-697-21-git-send-email-phil@nwl.cc \
    --to=phil@nwl.cc \
    --cc=netdev@vger.kernel.org \
    --cc=shemming@brocade.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).