Skip to contentSkip to conversation

man: fix typos

PATCH In review Samanta Navarro 3 participants 6 messages Oct 4, 2020 – Oct 8, 2020

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

PATCH 1/1 man: fix typos

---
 man/man8/ip-link.8.in   | 14 +++++++-------
 man/man8/ip-neighbour.8 |  6 +++---
 man/man8/tc-actions.8   |  2 +-
 man/man8/tc-pie.8       |  4 ++--
 4 files changed, 13 insertions(+), 13 deletions(-)
man/man8/ip-link.8.in +7 -7
index f451ecf..fbc45df 100644
@@ -392,7 +392,7 @@ packet the new device should accept.
 .TP
 .BI gso_max_segs " SEGMENTS "
 specifies the recommended maximum number of a Generic Segment Offload
-segments the new device should accept.
+segment the new device should accept.
 
 .TP
 .BI index " IDX "
@@ -441,7 +441,7 @@ the following additional arguments are supported:
 - either 802.1Q or 802.1ad.
 
 .BI id " VLANID "
-- specifies the VLAN Identifer to use. Note that numbers with a leading " 0 " or " 0x " are interpreted as octal or hexadeimal, respectively.
+- specifies the VLAN Identifier to use. Note that numbers with a leading " 0 " or " 0x " are interpreted as octal or hexadecimal, respectively.
 
 .BR reorder_hdr " { " on " | " off " } "
 - specifies whether ethernet headers are reordered or not (default is
@@ -572,7 +572,7 @@ the following additional arguments are supported:
 .in +8
 .sp
 .BI  id " VNI "
-- specifies the VXLAN Network Identifer (or VXLAN Segment
+- specifies the VXLAN Network Identifier (or VXLAN Segment
 Identifier) to use.
 
 .BI dev " PHYS_DEV"
@@ -1237,7 +1237,7 @@ the following additional arguments are supported:
 .in +8
 .sp
 .BI  id " VNI "
-- specifies the Virtual Network Identifer to use.
+- specifies the Virtual Network Identifier to use.
 
 .sp
 .BI remote " IPADDR"
@@ -2147,7 +2147,7 @@ loaded under
 .B xdpgeneric object "|" pinned
 then the kernel will use the generic XDP variant instead of the native one.
 .B xdpdrv
-has the opposite effect of requestsing that the automatic fallback to the
+has the opposite effect of requesting that the automatic fallback to the
 generic XDP variant be disabled and in case driver is not XDP-capable error
 should be returned.
 .B xdpdrv
@@ -2466,7 +2466,7 @@ specifies the master device which enslaves devices to show.
 .TP
 .BI vrf " NAME "
 .I NAME
-speficies the VRF which enslaves devices to show.
+specifies the VRF which enslaves devices to show.
 
 .TP
 .BI type " TYPE "
@@ -2497,7 +2497,7 @@ specifies the device to display address-family statistics for.
 
 .PP
 .I "TYPE"
-specifies which help of link type to dislpay.
+specifies which help of link type to display.
 
 .SS
 .I GROUP
man/man8/ip-neighbour.8 +3 -3
index f71f18b..a27f9ef 100644
@@ -85,11 +85,11 @@ the interface to which this neighbour is attached.
 
 .TP
 .BI proxy
-indicates whether we are proxying for this neigbour entry
+indicates whether we are proxying for this neighbour entry
 
 .TP
 .BI router
-indicates whether neigbour is a router
+indicates whether neighbour is a router
 
 .TP
 .BI extern_learn
@@ -244,7 +244,7 @@ lookup a neighbour entry to a destination given a device
 
 .TP
 .BI proxy
-indicates whether we should lookup a proxy neigbour entry
+indicates whether we should lookup a proxy neighbour entry
 
 .TP
 .BI to " ADDRESS " (default)
man/man8/tc-actions.8 +1 -1
index 6f1c201..80df577 100644
@@ -253,7 +253,7 @@ should proceed after executing the action. Any of the following are valid:
 .RS
 .TP
 .B reclassify
-Restart the classifiction by jumping back to the first filter attached to
+Restart the classification by jumping back to the first filter attached to
 the action's parent.
 .TP
 .B pipe
man/man8/tc-pie.8 +2 -2
index 0db97d1..5a8c782 100644
@@ -40,7 +40,7 @@ aims to control delay. The main design goals are
 PIE is designed to control delay effectively. First, an average dequeue rate is
 estimated based on the standing queue. The rate is used to calculate the current
 delay. Then, on a periodic basis, the delay is used to calculate the dropping
-probabilty. Finally, on arrival, a packet is dropped (or marked) based on this
+probability. Finally, on arrival, a packet is dropped (or marked) based on this
 probability.
 
 PIE makes adjustments to the probability based on the trend of the delay i.e.
@@ -52,7 +52,7 @@ growth and are determined through control theoretic approaches. alpha determines
 the deviation between the current and target latency changes probability. beta exerts
 additional adjustments depending on the latency trend.
 
-The drop probabilty is used to mark packets in ecn mode. However, as in RED,
+The drop probability is used to mark packets in ecn mode. However, as in RED,
 beyond 10% packets are dropped based on this probability. The bytemode is used
 to drop packets proportional to the packet size.
 
Signature · 1 line
2.28.0
#1 lore raw
Quoted 12 lines · Samanta Navarro
---
 man/man8/ip-link.8.in   | 14 +++++++-------
 man/man8/ip-neighbour.8 |  6 +++---
 man/man8/tc-actions.8   |  2 +-
 man/man8/tc-pie.8       |  4 ++--
 4 files changed, 13 insertions(+), 13 deletions(-)
man/man8/ip-link.8.in +0 -0
index f451ecf..fbc45df 100644

man/man8/ip-link.8.in packet the new device should accept. · line 395

Quoted 5 lines
man/man8/ip-link.8.in +1 -1
@@ -392,7 +392,7 @@ packet the new device should accept.
 .TP
 .BI gso_max_segs " SEGMENTS "
 specifies the recommended maximum number of a Generic Segment Offload
-segments the new device should accept.
+segment the new device should accept.

Hi Samanta

The original seems correct to me.

Andrew

#2 lore raw

---
Hello Andrew,

Quoted 9 lines · Andrew Lunn

Review packet the new device should accept. · line 395

Quoted 6 lines · Samanta Navarro
(quoted diff) +1 -1
@@ -392,7 +392,7 @@ packet the new device should accept.
 .TP
 .BI gso_max_segs " SEGMENTS "
 specifies the recommended maximum number of a Generic Segment Offload
-segments the new device should accept.
+segment the new device should accept.

The original seems correct to me.

when I shorten the sentence, it states:
"specifies the number of a segments the device should accept"

Either "a segment" or "segments" without "a" is correct.

After carefully evaluating the sentence in its context, I would agree that plural is supposed to be used there. The previous sentence in the manual page is almost identical. This is probably a copy&paste mistake. And this means that "a" should be removed instead.

Thank you for your feedback!

Samanta

---
 man/man8/ip-link.8.in   | 14 +++++++-------
 man/man8/ip-neighbour.8 |  6 +++---
 man/man8/tc-actions.8   |  2 +-
 man/man8/tc-pie.8       |  4 ++--
 4 files changed, 13 insertions(+), 13 deletions(-)
man/man8/ip-link.8.in +7 -7
index f451ecf..62d2d9f 100644
@@ -391,7 +391,7 @@ packet the new device should accept.
 
 .TP
 .BI gso_max_segs " SEGMENTS "
-specifies the recommended maximum number of a Generic Segment Offload
+specifies the recommended maximum number of Generic Segment Offload
 segments the new device should accept.
 
 .TP
@@ -441,7 +441,7 @@ the following additional arguments are supported:
 - either 802.1Q or 802.1ad.
 
 .BI id " VLANID "
-- specifies the VLAN Identifer to use. Note that numbers with a leading " 0 " or " 0x " are interpreted as octal or hexadeimal, respectively.
+- specifies the VLAN Identifier to use. Note that numbers with a leading " 0 " or " 0x " are interpreted as octal or hexadecimal, respectively.
 
 .BR reorder_hdr " { " on " | " off " } "
 - specifies whether ethernet headers are reordered or not (default is
@@ -572,7 +572,7 @@ the following additional arguments are supported:
 .in +8
 .sp
 .BI  id " VNI "
-- specifies the VXLAN Network Identifer (or VXLAN Segment
+- specifies the VXLAN Network Identifier (or VXLAN Segment
 Identifier) to use.
 
 .BI dev " PHYS_DEV"
@@ -1237,7 +1237,7 @@ the following additional arguments are supported:
 .in +8
 .sp
 .BI  id " VNI "
-- specifies the Virtual Network Identifer to use.
+- specifies the Virtual Network Identifier to use.
 
 .sp
 .BI remote " IPADDR"
@@ -2147,7 +2147,7 @@ loaded under
 .B xdpgeneric object "|" pinned
 then the kernel will use the generic XDP variant instead of the native one.
 .B xdpdrv
-has the opposite effect of requestsing that the automatic fallback to the
+has the opposite effect of requesting that the automatic fallback to the
 generic XDP variant be disabled and in case driver is not XDP-capable error
 should be returned.
 .B xdpdrv
@@ -2466,7 +2466,7 @@ specifies the master device which enslaves devices to show.
 .TP
 .BI vrf " NAME "
 .I NAME
-speficies the VRF which enslaves devices to show.
+specifies the VRF which enslaves devices to show.
 
 .TP
 .BI type " TYPE "
@@ -2497,7 +2497,7 @@ specifies the device to display address-family statistics for.
 
 .PP
 .I "TYPE"
-specifies which help of link type to dislpay.
+specifies which help of link type to display.
 
 .SS
 .I GROUP
man/man8/ip-neighbour.8 +3 -3
index f71f18b..a27f9ef 100644
@@ -85,11 +85,11 @@ the interface to which this neighbour is attached.
 
 .TP
 .BI proxy
-indicates whether we are proxying for this neigbour entry
+indicates whether we are proxying for this neighbour entry
 
 .TP
 .BI router
-indicates whether neigbour is a router
+indicates whether neighbour is a router
 
 .TP
 .BI extern_learn
@@ -244,7 +244,7 @@ lookup a neighbour entry to a destination given a device
 
 .TP
 .BI proxy
-indicates whether we should lookup a proxy neigbour entry
+indicates whether we should lookup a proxy neighbour entry
 
 .TP
 .BI to " ADDRESS " (default)
man/man8/tc-actions.8 +1 -1
index 6f1c201..80df577 100644
@@ -253,7 +253,7 @@ should proceed after executing the action. Any of the following are valid:
 .RS
 .TP
 .B reclassify
-Restart the classifiction by jumping back to the first filter attached to
+Restart the classification by jumping back to the first filter attached to
 the action's parent.
 .TP
 .B pipe
man/man8/tc-pie.8 +2 -2
index 0db97d1..5a8c782 100644
@@ -40,7 +40,7 @@ aims to control delay. The main design goals are
 PIE is designed to control delay effectively. First, an average dequeue rate is
 estimated based on the standing queue. The rate is used to calculate the current
 delay. Then, on a periodic basis, the delay is used to calculate the dropping
-probabilty. Finally, on arrival, a packet is dropped (or marked) based on this
+probability. Finally, on arrival, a packet is dropped (or marked) based on this
 probability.
 
 PIE makes adjustments to the probability based on the trend of the delay i.e.
@@ -52,7 +52,7 @@ growth and are determined through control theoretic approaches. alpha determines
 the deviation between the current and target latency changes probability. beta exerts
 additional adjustments depending on the latency trend.
 
-The drop probabilty is used to mark packets in ecn mode. However, as in RED,
+The drop probability is used to mark packets in ecn mode. However, as in RED,
 beyond 10% packets are dropped based on this probability. The bytemode is used
 to drop packets proportional to the packet size.
 
Signature · 1 line
2.28.0
#3 lore raw
Quoted 17 lines · Samanta Navarro

---
Hello Andrew,

Quoted 9 lines · Andrew Lunn

Review packet the new device should accept. · line 395

Quoted 6 lines · Samanta Navarro
(quoted diff) +1 -1
@@ -392,7 +392,7 @@ packet the new device should accept.
 .TP
 .BI gso_max_segs " SEGMENTS "
 specifies the recommended maximum number of a Generic Segment Offload
-segments the new device should accept.
+segment the new device should accept.

The original seems correct to me.

when I shorten the sentence, it states:
"specifies the number of a segments the device should accept"

Quoted 6 lines

Either "a segment" or "segments" without "a" is correct.

After carefully evaluating the sentence in its context, I would agree that plural is supposed to be used there. The previous sentence in the manual page is almost identical. This is probably a copy&paste mistake. And this means that "a" should be removed instead.

Yes, i agree, please drop the 'a'.

Andrew

#5 lore raw
---
 man/man8/ip-link.8.in   | 14 +++++++-------
 man/man8/ip-neighbour.8 |  6 +++---
 man/man8/tc-actions.8   |  2 +-
 man/man8/tc-pie.8       |  4 ++--
 4 files changed, 13 insertions(+), 13 deletions(-)
man/man8/ip-link.8.in +7 -7
index f451ecf..62d2d9f 100644
@@ -391,7 +391,7 @@ packet the new device should accept.
 
 .TP
 .BI gso_max_segs " SEGMENTS "
-specifies the recommended maximum number of a Generic Segment Offload
+specifies the recommended maximum number of Generic Segment Offload
 segments the new device should accept.
 
 .TP
@@ -441,7 +441,7 @@ the following additional arguments are supported:
 - either 802.1Q or 802.1ad.
 
 .BI id " VLANID "
-- specifies the VLAN Identifer to use. Note that numbers with a leading " 0 " or " 0x " are interpreted as octal or hexadeimal, respectively.
+- specifies the VLAN Identifier to use. Note that numbers with a leading " 0 " or " 0x " are interpreted as octal or hexadecimal, respectively.
 
 .BR reorder_hdr " { " on " | " off " } "
 - specifies whether ethernet headers are reordered or not (default is
@@ -572,7 +572,7 @@ the following additional arguments are supported:
 .in +8
 .sp
 .BI  id " VNI "
-- specifies the VXLAN Network Identifer (or VXLAN Segment
+- specifies the VXLAN Network Identifier (or VXLAN Segment
 Identifier) to use.
 
 .BI dev " PHYS_DEV"
@@ -1237,7 +1237,7 @@ the following additional arguments are supported:
 .in +8
 .sp
 .BI  id " VNI "
-- specifies the Virtual Network Identifer to use.
+- specifies the Virtual Network Identifier to use.
 
 .sp
 .BI remote " IPADDR"
@@ -2147,7 +2147,7 @@ loaded under
 .B xdpgeneric object "|" pinned
 then the kernel will use the generic XDP variant instead of the native one.
 .B xdpdrv
-has the opposite effect of requestsing that the automatic fallback to the
+has the opposite effect of requesting that the automatic fallback to the
 generic XDP variant be disabled and in case driver is not XDP-capable error
 should be returned.
 .B xdpdrv
@@ -2466,7 +2466,7 @@ specifies the master device which enslaves devices to show.
 .TP
 .BI vrf " NAME "
 .I NAME
-speficies the VRF which enslaves devices to show.
+specifies the VRF which enslaves devices to show.
 
 .TP
 .BI type " TYPE "
@@ -2497,7 +2497,7 @@ specifies the device to display address-family statistics for.
 
 .PP
 .I "TYPE"
-specifies which help of link type to dislpay.
+specifies which help of link type to display.
 
 .SS
 .I GROUP
man/man8/ip-neighbour.8 +3 -3
index f71f18b..a27f9ef 100644
@@ -85,11 +85,11 @@ the interface to which this neighbour is attached.
 
 .TP
 .BI proxy
-indicates whether we are proxying for this neigbour entry
+indicates whether we are proxying for this neighbour entry
 
 .TP
 .BI router
-indicates whether neigbour is a router
+indicates whether neighbour is a router
 
 .TP
 .BI extern_learn
@@ -244,7 +244,7 @@ lookup a neighbour entry to a destination given a device
 
 .TP
 .BI proxy
-indicates whether we should lookup a proxy neigbour entry
+indicates whether we should lookup a proxy neighbour entry
 
 .TP
 .BI to " ADDRESS " (default)
man/man8/tc-actions.8 +1 -1
index 6f1c201..80df577 100644
@@ -253,7 +253,7 @@ should proceed after executing the action. Any of the following are valid:
 .RS
 .TP
 .B reclassify
-Restart the classifiction by jumping back to the first filter attached to
+Restart the classification by jumping back to the first filter attached to
 the action's parent.
 .TP
 .B pipe
man/man8/tc-pie.8 +2 -2
index 0db97d1..5a8c782 100644
@@ -40,7 +40,7 @@ aims to control delay. The main design goals are
 PIE is designed to control delay effectively. First, an average dequeue rate is
 estimated based on the standing queue. The rate is used to calculate the current
 delay. Then, on a periodic basis, the delay is used to calculate the dropping
-probabilty. Finally, on arrival, a packet is dropped (or marked) based on this
+probability. Finally, on arrival, a packet is dropped (or marked) based on this
 probability.
 
 PIE makes adjustments to the probability based on the trend of the delay i.e.
@@ -52,7 +52,7 @@ growth and are determined through control theoretic approaches. alpha determines
 the deviation between the current and target latency changes probability. beta exerts
 additional adjustments depending on the latency trend.
 
-The drop probabilty is used to mark packets in ecn mode. However, as in RED,
+The drop probability is used to mark packets in ecn mode. However, as in RED,
 beyond 10% packets are dropped based on this probability. The bytemode is used
 to drop packets proportional to the packet size.
 
Signature · 1 line
2.28.0