Skip to contentSkip to conversation

ethtool: fix man page errors

PATCH In review Xose Vazquez Perez 2 participants 4 messages Oct 24, 2022 – Oct 28, 2022

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 ethtool: fix man page errors

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

---
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(-)
ethtool.8.in +3 -3
index dee39dd..c4477f0 100644
@@ -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
@@ -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.
Signature · 1 line
2.38.1
#1 lore raw
Quoted 11 lines · Xose Vazquez Perez

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

---
Tested with:
man --warnings -E UTF-8 -l -Tutf8 -Z ethtool.8 > /dev/null groff -z -wall -b -e -t ethtool.8

These errors are not related to the patch, v6.0 gives exactly the same result. The changes below should fix them but I'll rather double check before submitting it, I'm not very familiar with the syntax.

Michal

-8<---

ethtool.8.in +2 -4
index 1c0e2346f3a1..f34e945e271d 100644
@@ -79,7 +79,6 @@
 .\"	\(*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 +248,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
@@ -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<---

#2 lore raw
Quoted 13 lines · Michal Kubecek
Quoted 11 lines · Xose Vazquez Perez

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

---
Tested with:
man --warnings -E UTF-8 -l -Tutf8 -Z ethtool.8 > /dev/null groff -z -wall -b -e -t ethtool.8

Quoted 3 lines

These errors are not related to the patch, v6.0 gives exactly the same result. The changes below should fix them but I'll rather double check before submitting it, I'm not very familiar with the syntax.

Sorry for the noise, I thought this was sent as a response to my earlier patch. I'll send a proper review in a moment.

Michal

#3 lore raw
In reply to Xose Vazquez Perez
Quoted 30 lines · Xose Vazquez Perez

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

---
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(-)
ethtool.8.in +1 -1
index dee39dd..c4477f0 100644
@@ -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

ethtool.8.in ethtool \- query or control network driver and hardware settings · line 255

Quoted 8 lines
ethtool.8.in +1 -1
@@ -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.

ethtool.8.in naming of NIC- and driver-specific statistics across vendors. · line 701

Quoted 9 lines
ethtool.8.in +1 -1
@@ -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