diff mbox series

[iproute] man/tc-codel: cleanup man page

Message ID 20240811165501.7807-1-stephen@networkplumber.org (mailing list archive)
State Accepted
Commit 6e4c3ffb82278c7abeac7c4896db703ce57d958e
Delegated to: Stephen Hemminger
Headers show
Series [iproute] man/tc-codel: cleanup man page | expand

Checks

Context Check Description
netdev/tree_selection success Not a local patch

Commit Message

Stephen Hemminger Aug. 11, 2024, 4:54 p.m. UTC 
Instead of pre-formatted bullet list, use the man macros.
Make sure same sentence format is used in all options.

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 man/man8/tc-codel.8 | 19 ++++++++++++-------
 1 file changed, 12 insertions(+), 7 deletions(-)

Comments

patchwork-bot+netdevbpf@kernel.org Aug. 12, 2024, 9:30 p.m. UTC | #1 
Hello:

This patch was applied to iproute2/iproute2.git (main)
by Stephen Hemminger <stephen@networkplumber.org>:

On Sun, 11 Aug 2024 09:54:44 -0700 you wrote:
> Instead of pre-formatted bullet list, use the man macros.
> Make sure same sentence format is used in all options.
> 
> Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
> ---
>  man/man8/tc-codel.8 | 19 ++++++++++++-------
>  1 file changed, 12 insertions(+), 7 deletions(-)

Here is the summary with links:
  - [iproute] man/tc-codel: cleanup man page
    https://git.kernel.org/pub/scm/network/iproute2/iproute2.git/commit/?id=6e4c3ffb8227

You are awesome, thank you!
diff mbox series

Patch

diff --git a/man/man8/tc-codel.8 b/man/man8/tc-codel.8
index e538e940..7bf08667 100644
--- a/man/man8/tc-codel.8
+++ b/man/man8/tc-codel.8
@@ -22,12 +22,17 @@  CoDel (pronounced "coddle") is an adaptive "no-knobs" active queue management
 algorithm (AQM) scheme that was developed to address the shortcomings of
 RED and its variants. It was developed with the following goals
 in mind:
- o It should be parameterless.
- o It should keep delays low while permitting bursts of traffic.
- o It should control delay.
- o It should adapt dynamically to changing link rates with no impact on
+.IP * 4
+It should be parameterless.
+.IP *
+It should keep delays low while permitting bursts of traffic.
+.IP *
+It should control delay.
+.IP *
+It should adapt dynamically to changing link rates with no impact on
 utilization.
- o It should be simple and efficient and should scale from simple to
+.IP *
+It should be simple and efficient and should scale from simple to
 complex routers.
 
 .SH ALGORITHM
@@ -57,7 +62,7 @@  Additional details can be found in the paper cited below.
 
 .SH PARAMETERS
 .SS limit
-hard limit on the real queue size. When this limit is reached, incoming packets
+is the hard limit on the real queue size. When this limit is reached, incoming packets
 are dropped. If the value is lowered, packets are dropped so that the new limit is
 met. Default is 1000 packets.
 
@@ -113,7 +118,7 @@  interval 30.0ms ecn
 .BR tc-red (8)
 
 .SH SOURCES
-o   Kathleen Nichols and Van Jacobson, "Controlling Queue Delay", ACM Queue,
+Kathleen Nichols and Van Jacobson, "Controlling Queue Delay", ACM Queue,
 http://queue.acm.org/detail.cfm?id=2209336
 
 .SH AUTHORS