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

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

Message-ID: <20240811165501.7807-1-stephen@networkplumber.org>
Date: Sun, 11 Aug 2024 09:54:44 -0700
From: Stephen Hemminger <stephen@...workplumber.org>
To: netdev@...r.kernel.org
Cc: Stephen Hemminger <stephen@...workplumber.org>
Subject: [PATCH iproute] man/tc-codel: cleanup man page

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@...workplumber.org>
---
 man/man8/tc-codel.8 | 19 ++++++++++++-------
 1 file changed, 12 insertions(+), 7 deletions(-)

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
-- 
2.43.0