From 3ee62883e37a1608b9801385c1e8c95e381290c9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20K=C4=99pie=C5=84?= Date: Tue, 22 Jun 2021 22:26:46 +0200 Subject: [PATCH 1/2] Fix typos in buffering-related option names The ARM contains typos in the names of the following two options: - "tcp-receive-buffer" - "udp-receive-buffer" Fix the ARM so that it contains proper option names. --- doc/arm/reference.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/arm/reference.rst b/doc/arm/reference.rst index 26a75c4e68..d654bd9e65 100644 --- a/doc/arm/reference.rst +++ b/doc/arm/reference.rst @@ -3610,7 +3610,7 @@ Tuning milliseconds to prefer IPv6 name servers. The default is ``50`` milliseconds. -``tcp-recv-buffer``; ``udp-recv-buffer`` +``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 the operating system level can prevent packet drops during brief load From a43cafe77d015d7721c9d8fcb7baa6dac61db631 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20K=C4=99pie=C5=84?= Date: Tue, 22 Jun 2021 22:26:46 +0200 Subject: [PATCH 2/2] 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. --- doc/arm/reference.rst | 32 +++++++++++++++++--------------- 1 file changed, 17 insertions(+), 15 deletions(-) diff --git a/doc/arm/reference.rst b/doc/arm/reference.rst index d654bd9e65..8038d5b45b 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: