From: Michał Kępień Date: Tue, 22 Jun 2021 20:26:46 +0000 (+0200) Subject: Tweak descriptions of buffering-related options X-Git-Tag: v9.17.16~23^2 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=a43cafe77d015d7721c9d8fcb7baa6dac61db631;p=thirdparty%2Fbind9.git Tweak descriptions of buffering-related options Apply minor stylistical and whitespace-related tweaks to the descriptions of the "tcp-receive-buffer", "udp-receive-buffer", "tcp-send-buffer", and "udp-send-buffer" options in the ARM. --- diff --git a/doc/arm/reference.rst b/doc/arm/reference.rst index d654bd9e65e..8038d5b45b3 100644 --- a/doc/arm/reference.rst +++ b/doc/arm/reference.rst @@ -3612,25 +3612,27 @@ Tuning ``tcp-receive-buffer``; ``udp-receive-buffer`` These options control the operating system's receive buffer sizes - (``SO_RCVBUF``) for TCP and UDP sockets respectively. Buffering at + (``SO_RCVBUF``) for TCP and UDP sockets, respectively. Buffering at the operating system level can prevent packet drops during brief load - spikes, but if the value is set too high, it could clog a running server - with outstanding queries that have already timed out. The default is - ``0``, which means the operating system's default value should be used. - The minimum configurable value is ``4096``; any nonzero value lower than - that will be silently raised. The maximum value is determined by the - kernel, and values exceeding the maximum will be silently reduced. + spikes, but if the buffer size is set too high, a running server + could get clogged with outstanding queries that have already timed + out. The default is ``0``, which means the operating system's default + value should be used. The minimum configurable value is ``4096``; any + nonzero value lower than that is silently raised. The maximum value + is determined by the kernel, and values exceeding the maximum are + silently reduced. ``tcp-send-buffer``; ``udp-send-buffer`` These options control the operating system's send buffer sizes - (``SO_SNDBUF``) for TCP and UDP sockets respectively. Buffering at the - operating system level can prevent packet drops during brief load - spikes, but if the value is set too high, it could clog a running server - with outstanding queries that have already timed out. The default is - ``0``, which means the operating system's default value should be used. - The minimum configurable value is ``4096``; any nonzero value lower than - that will be silently raised. The maximum value is determined by the - kernel, and values exceeding the maximum will be silently reduced. + (``SO_SNDBUF``) for TCP and UDP sockets, respectively. Buffering at + the operating system level can prevent packet drops during brief load + spikes, but if the buffer size is set too high, a running server + could get clogged with outstanding queries that have already timed + out. The default is ``0``, which means the operating system's default + value should be used. The minimum configurable value is ``4096``; any + nonzero value lower than that is silently raised. The maximum value + is determined by the kernel, and values exceeding the maximum are + silently reduced. .. _builtin: