netdev - Re: [PATCH] ethtool: fix man page errors

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-prev] [day] [month] [year] [list]

Message-ID: <20221028225128.nwhsqdjbme6kx3d5@lion.mk-sys.cz>
Date:   Sat, 29 Oct 2022 00:51:28 +0200
From:   Michal Kubecek <mkubecek@...e.cz>
To:     Xose Vazquez Perez <xose.vazquez@...il.com>
Cc:     NETDEV ML <netdev@...r.kernel.org>
Subject: Re: [PATCH] ethtool: fix man page errors

On Mon, Oct 24, 2022 at 06:39:46PM +0200, Xose Vazquez Perez wrote:
> troff: <standard input>:82: warning: macro '.' not defined
> troff: <standard input>:252: warning: macro 'RN' not defined
> troff: <standard input>:698: warning: macro 'E' not defined
> 
> Cc: Michal Kubecek <mkubecek@...e.cz>
> Cc: NETDEV ML <netdev@...r.kernel.org>
> Signed-off-by: Xose Vazquez Perez <xose.vazquez@...il.com>
> ---
> Tested with:
> man --warnings -E UTF-8 -l -Tutf8 -Z ethtool.8 > /dev/null
> groff -z -wall -b -e -t ethtool.8
> 
> ---
>  ethtool.8.in | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/ethtool.8.in b/ethtool.8.in
> index dee39dd..c4477f0 100644
> --- a/ethtool.8.in
> +++ b/ethtool.8.in
> @@ -79,7 +79,7 @@
>  .\"	\(*NC - Network Classifier type values
>  .\"
>  .ds NC \fBether\fP|\fBip4\fP|\fBtcp4\fP|\fBudp4\fP|\fBsctp4\fP|\fBah4\fP|\fBesp4\fP|\fBip6\fP|\fBtcp6\fP|\fBudp6\fP|\fBah6\fP|\fBesp6\fP|\fBsctp6\fP
> -..
> +.
>  .\"
>  .\" Start URL.
>  .de UR
> @@ -249,7 +249,7 @@ ethtool \- query or control network driver and hardware settings
>  .RB [\fBeth\-phy\fP]
>  .RB [\fBeth\-mac\fP]
>  .RB [\fBeth\-ctrl\fP]
> -.RN [\fBrmon\fP]
> +.RB [\fBrmon\fP]
>  .RB ]
>  .HP
>  .B ethtool \-\-phy\-statistics

These two changes look good to me.

> @@ -695,7 +695,7 @@ naming of NIC- and driver-specific statistics across vendors.
>  .RS 4
>  .TP
>  .B \fB\-\-all\-groups
> -.E
> +.RE
>  .TP
>  .B \fB\-\-groups [\fBeth\-phy\fP] [\fBeth\-mac\fP] [\fBeth\-ctrl\fP] [\fBrmon\fP]
>  Request groups of standard device statistics.

I believe ".RE" is wrong here as it would result in "--groups ..." not
indented correctly (like "-t --test" rather than like "--all-groups").
The same problem already exists between "--groups ..." and
"--phy-statistics" which is incorrectly indented. IMHO the ".RE" should
not come until after "--phy-statistics", i.e.

--8<--------
@@ -695,14 +694,13 @@ naming of NIC- and driver-specific statistics across vendors.
 .RS 4
 .TP
 .B \fB\-\-all\-groups
-.E
 .TP
 .B \fB\-\-groups [\fBeth\-phy\fP] [\fBeth\-mac\fP] [\fBeth\-ctrl\fP] [\fBrmon\fP]
 Request groups of standard device statistics.
-.RE
 .TP
 .B \-\-phy\-statistics
 Queries the specified network device for PHY specific statistics.
+.RE
 .TP
 .B \-t \-\-test
 Executes adapter selftest on the specified network device. Possible test modes are:
--8<--------

Michal

Download attachment "signature.asc" of type "application/pgp-signature" (489 bytes)