diff xml/en/docs/http/ngx_http_core_module.xml @ 2118:0b3103eabdf1

Documented the "subrequest_output_buffer_size" directive.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 20 Mar 2018 21:03:28 +0300
parents d2969b2f69ae
children cf9e3d2893b6
line wrap: on
line diff
--- 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="74">
+        rev="75">
 
 <section id="directives" name="Directives">
 
@@ -2570,6 +2570,32 @@ An empty string disables the emission of
 </directive>
 
 
+<directive name="subrequest_output_buffer_size">
+<syntax><value>size</value></syntax>
+<default>4k|8k</default>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+<appeared-in>1.13.10</appeared-in>
+
+<para>
+Sets the <value>size</value> of the buffer used for
+storing the response body of a subrequest.
+By default, the buffer size is equal to one memory page.
+This is either 4K or 8K, depending on a platform.
+It can be made smaller, however.
+</para>
+
+<para>
+The directive is applicable only for subrequests
+with response bodies saved into memory.
+For example, such subrequests are created by
+<link doc="ngx_http_ssi_module.xml" id="ssi_include_set">SSI</link>.
+</para>
+
+</directive>
+
+
 <directive name="tcp_nodelay">
 <syntax><literal>on</literal> | <literal>off</literal></syntax>
 <default>on</default>