[nginx-site] Documented limit_rate algorithm change to leaky buc...

[Maxim Dounin]

details:   http://freenginx.org/hg/nginx-site/rev/4a0383b1afed
branches:  
changeset: 3104:4a0383b1afed
user:      Maxim Dounin <mdounin at mdounin.ru>
date:      Mon Jul 07 06:35:52 2025 +0300
description:
Documented limit_rate algorithm change to leaky bucket.

diffstat:

 xml/en/docs/http/ngx_http_core_module.xml |  21 ++++++++++++++-------
 xml/ru/docs/http/ngx_http_core_module.xml |  19 +++++++++++++------
 2 files changed, 27 insertions(+), 13 deletions(-)

diffs (104 lines):

diff --git a/xml/en/docs/http/ngx_http_core_module.xml b/xml/en/docs/http/ngx_http_core_module.xml
--- a/xml/en/docs/http/ngx_http_core_module.xml
+++ b/xml/en/docs/http/ngx_http_core_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_core_module"
         link="/en/docs/http/ngx_http_core_module.html"
         lang="en"
-        rev="109">
+        rev="110">
 
 <section id="directives" name="Directives">
 
@@ -1093,12 +1093,9 @@ Please note that this will limit access 
 <context>if in location</context>
 
 <para>
-Limits the rate of response transmission to a client.
+Limits the rate of response transmission to the client.
 The <value>rate</value> is specified in bytes per second.
 The zero value disables rate limiting.
-<!--
-The smaller the rate, the more accurate will be the limitation.
--->
 The limit is set per a request, and so if a client simultaneously opens
 two connections, the overall rate will be twice as much
 as the specified limit.
@@ -1159,8 +1156,9 @@ directives.
 <appeared-in>0.8.0</appeared-in>
 
 <para>
-Sets the initial amount after which the further transmission
-of a response to a client will be rate limited.
+Specifies the allowed size of data bursts
+after which the further transmission of a response to the client
+will be rate limited.
 Parameter value can contain variables (1.17.0).
 </para>
 
@@ -1175,6 +1173,15 @@ location /flv/ {
 </example>
 </para>
 
+<para>
+<note>
+Prior to version 1.29.0,
+this directive controlled the initial amount of data
+sent without rate limiting
+rather than the size of bursts.
+</note>
+</para>
+
 </directive>
 
 
diff --git a/xml/ru/docs/http/ngx_http_core_module.xml b/xml/ru/docs/http/ngx_http_core_module.xml
--- a/xml/ru/docs/http/ngx_http_core_module.xml
+++ b/xml/ru/docs/http/ngx_http_core_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_core_module"
         link="/ru/docs/http/ngx_http_core_module.html"
         lang="ru"
-        rev="109">
+        rev="110">
 
 <section id="directives" name="Директивы">
 
@@ -1090,9 +1090,6 @@ limit_except GET {
 Ограничивает скорость передачи ответа клиенту.
 <value>Скорость</value> задаётся в байтах в секунду.
 Значение 0 отключает ограничение скорости.
-<!--
-Чем меньше скорость, тем более аккуратным будет ограничение.
--->
 Ограничение устанавливается на запрос, поэтому, если клиент одновременно
 откроет два соединения, суммарная скорость будет вдвое выше
 заданного ограничения.
@@ -1152,8 +1149,9 @@ server {
 <appeared-in>0.8.0</appeared-in>
 
 <para>
-Задаёт начальный объём данных, после передачи которого начинает
-ограничиваться скорость передачи ответа клиенту.
+Задаёт допустимый размер всплесков при передаче данных,
+при превышении которого начинает ограничиваться скорость
+передачи ответа клиенту.
 В значении параметра можно использовать переменные (1.17.0).
 </para>
 
@@ -1168,6 +1166,15 @@ location /flv/ {
 </example>
 </para>
 
+<para>
+<note>
+До версии 1.29.0
+эта директива задавала начальный объём данных,
+отправляемый без ограничения скорости,
+а не размер всплесков.
+</note>
+</para>
+
 </directive>