Opened 3 weeks ago

Closed 3 weeks ago

#2086 closed enhancement (wontfix)

The relationship between directive "proxy_busy_buffers_size" and other two directives is not recorded clearly.

Reported by: zhoushulin1992@… Owned by:
Priority: minor Milestone:
Component: documentation Version: 1.18.x
Keywords: Cc: zhoushulin1992@…
uname -a: Linux xlarge 4.15.0-72-generic #81-Ubuntu SMP Tue Nov 26 12:20:02 UTC 2019 x86_64 x86_64 x86_64 GNU/Linux
nginx -V: nginx version: nginx/1.18.0
built by gcc 7.4.0 (Ubuntu 7.4.0-1ubuntu1~18.04.1)
configure arguments: --prefix=/usr/local/nginx --with-pcre=/root/Downloads/pcre-8.43

Description

In the document of directive "proxy_busy_buffers_size", it says that "By default, size is limited by the size of two buffers set by the proxy_buffer_size and proxy_buffers directives". Indeed, based on the handling logic in src/http/modules/ngx_http_proxy_module.c, the value of "proxy_busy_buffers_size" must be equal or greater than the maximum of the value of "proxy_buffer_size" and "proxy_buffers" size. So it is recommended to add this information in the doc of "proxy_busy_buffers_size"(https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_busy_buffers_size).

The same situation happens in directive "proxy_temp_file_write_size" in https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_temp_file_write_size, and directive "proxy_max_temp_file_size" in https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_max_temp_file_size. They should all be equal or greater than the maximum of the value of "proxy_buffer_size" and "proxy_buffers" size.

What's more, the value of directive "proxy_busy_buffers_size" must be less than (number-of-proxy_buffers - 1)*size-of-proxy_buffers. This also should be recorded.

Change History (2)

comment:1 by Maxim Dounin, 3 weeks ago

See also #2085, #2087, and #2088.

comment:2 by Maxim Dounin, 3 weeks ago

Resolution: wontfix
Status: newclosed

Thank you for your suggestion. It is believed that not all limitations have to be documented, mostly because this needlessly complicates reading of the documentation, and appropriate error reported during configuration parsing is enough.

Note: See TracTickets for help on using tickets.