More manual-page fixups.

Message ID 20180613213112.GA19190@thyrsus.com
State Accepted
Delegated to: stephen hemminger
Headers show
Series
  • More manual-page fixups.
Related show

Commit Message

Eric S. Raymond June 13, 2018, 9:31 p.m.
John Linville asked me to ship the ethtool.8 patch to this list.
That's the first 0001 patch in the enclosures and should be applied
to the ethtool repo.

The others are more syntax fixups for the iproute2 repo.  Some
are things like list syntax errors that you don't notice when
rendering via groff because it has no error checking. Some others
unroll the pseudo-BNF used in some synopses to the standard form
described by DocBook synopsis markup.

There's more work to be done on this.  Expect more patches, now
that I know where to send them.

Patch

From 643db903b3f6cd90dce5cc90daafcd6830e83a8a Mon Sep 17 00:00:00 2001
From: "Eric S. Raymond" <esr@thyrsus.com>
Date: Wed, 13 Jun 2018 12:45:24 -0400
Subject: [PATCH 5/5] In devlink.8, translate unparseable callout syntax to
 parseable form.

Signed-off-by: Eric S. Raymond <esr@thyrsus.com>
---
 man/man8/devlink.8 | 14 +-------------
 1 file changed, 1 insertion(+), 13 deletions(-)

diff --git a/man/man8/devlink.8 b/man/man8/devlink.8
index 7986310f..efc6e625 100644
--- a/man/man8/devlink.8
+++ b/man/man8/devlink.8
@@ -7,7 +7,7 @@  devlink \- Devlink tool
 .in +8
 .ti -8
 .B devlink
-.RI "[ " OPTIONS " ] " OBJECT " { " COMMAND " | "
+.RI "[ " OPTIONS " ] { " dev | port | monitor | sb | resource " } { " COMMAND " | "
 .BR help " }"
 .sp
 
@@ -17,18 +17,6 @@  devlink \- Devlink tool
 .BI "-batch " filename
 .sp
 
-.ti -8
-.IR OBJECT " := { "
-.BR dev " | " port " | " monitor " | " sb " | " resource " }"
-.sp
-
-.ti -8
-.IR OPTIONS " := { "
-\fB\-V\fR[\fIersion\fR] |
-\fB\-n\fR[\fIno-nice-names\fR] }
-\fB\-j\fR[\fIjson\fR] }
-\fB\-p\fR[\fIpretty\fR] }
-
 .SH OPTIONS
 
 .TP
-- 
2.17.1