git: eba715c544ea - main - icmp.4: improve icmplim and add icmplim_jitter description

From: Michael Tuexen <tuexen_at_FreeBSD.org>
Date: Wed, 11 Dec 2024 18:50:16 UTC
The branch main has been updated by tuexen:

URL: https://cgit.FreeBSD.org/src/commit/?id=eba715c544ea89c6b402c55e03b388b77030b997

commit eba715c544ea89c6b402c55e03b388b77030b997
Author:     Michael Tuexen <tuexen@FreeBSD.org>
AuthorDate: 2024-12-11 18:47:11 +0000
Commit:     Michael Tuexen <tuexen@FreeBSD.org>
CommitDate: 2024-12-11 18:47:11 +0000

    icmp.4: improve icmplim and add icmplim_jitter description
    
    Reviewed by:            cc, bcr
    MFC after:              1 week
    Sponsored by:           Netflix, Inc.
    Differential Revision:  https://reviews.freebsd.org/D48025
---
 share/man/man4/icmp.4 | 27 ++++++++++++++++++++++++---
 1 file changed, 24 insertions(+), 3 deletions(-)

diff --git a/share/man/man4/icmp.4 b/share/man/man4/icmp.4
index 7bc844edd3c0..c8c92a794e24 100644
--- a/share/man/man4/icmp.4
+++ b/share/man/man4/icmp.4
@@ -25,7 +25,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd August 1, 2022
+.Dd December 11, 2024
 .Dt ICMP 4
 .Os
 .Sh NAME
@@ -169,10 +169,31 @@ Defaults to false.
 Enable/disable dropping of ICMP Redirect packets.
 Defaults to false.
 .It Va icmplim
-.Pq Vt integer
-Bandwidth limit for ICMP replies in packets/second.
+.Pq Vt unsigned integer
+Mean rate limit for replies in packets/second.
+The actual limit is
+.Va icmplim
+plus a random jitter limited by
+.Va icmplim_jitter .
 If set to zero, no limiting will occur.
 Defaults to 200.
+.It Va icmplim_jitter
+.Pq Vt unsigned integer
+A random jitter between the negative of
+.Va icmplim_jitter
+and
+.Va icmplim_jitter
+is applied to
+.Va icmplim
+for limiting the sending rate of replies.
+.Va icmplim_jitter
+must be smaller than
+.Va icmplim ,
+if
+.Va icmplim
+is not zero.
+If set to zero, no jitter will be applied.
+Defaults to 16.
 .It Va icmplim_output
 .Pq Vt boolean
 Enable/disable logging of ICMP replies bandwidth limiting.