# HG changeset patch
# User Yaroslav Zhuravlev <yar@nginx.com>
# Date 1487189814 -10800
# Node ID 399d0e188195552a48593db227728f6c9108605e
# Parent  d6692a78a444a0716c338aea3585812490205e14
Documented proxy_cache_background_update and friends.

diff -r d6692a78a444 -r 399d0e188195 xml/en/docs/http/ngx_http_fastcgi_module.xml
--- a/xml/en/docs/http/ngx_http_fastcgi_module.xml	Tue Feb 14 18:46:35 2017 +0300
+++ b/xml/en/docs/http/ngx_http_fastcgi_module.xml	Wed Feb 15 23:16:54 2017 +0300
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_fastcgi_module"
         link="/en/docs/http/ngx_http_fastcgi_module.html"
         lang="en"
-        rev="40">
+        rev="41">
 
 <section id="summary">
 
@@ -201,6 +201,26 @@
 </directive>
 
 
+<directive name="fastcgi_cache_background_update">
+<syntax><literal>on</literal> | <literal>off</literal></syntax>
+<default>off</default>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+<appeared-in>1.11.10</appeared-in>
+
+<para>
+Allows starting a background subrequest
+to update an expired cache item,
+while a stale cached response is returned to the client.
+Note that it is necessary to
+<link id="fastcgi_cache_use_stale_updating">allow</link>
+the usage of a stale cached response when it is being updated.
+</para>
+
+</directive>
+
+
 <directive name="fastcgi_cache_bypass">
 <syntax><value>string</value> ...</syntax>
 <default/>
@@ -613,7 +633,7 @@
 cannot be selected.
 </para>
 
-<para>
+<para id="fastcgi_cache_use_stale_updating">
 Additionally, the <literal>updating</literal> parameter permits
 using a stale cached response if it is currently being updated.
 This allows minimizing the number of accesses to FastCGI servers
diff -r d6692a78a444 -r 399d0e188195 xml/en/docs/http/ngx_http_proxy_module.xml
--- a/xml/en/docs/http/ngx_http_proxy_module.xml	Tue Feb 14 18:46:35 2017 +0300
+++ b/xml/en/docs/http/ngx_http_proxy_module.xml	Wed Feb 15 23:16:54 2017 +0300
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_proxy_module"
         link="/en/docs/http/ngx_http_proxy_module.html"
         lang="en"
-        rev="54">
+        rev="55">
 
 <section id="summary">
 
@@ -195,6 +195,26 @@
 </directive>
 
 
+<directive name="proxy_cache_background_update">
+<syntax><literal>on</literal> | <literal>off</literal></syntax>
+<default>off</default>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+<appeared-in>1.11.10</appeared-in>
+
+<para>
+Allows starting a background subrequest
+to update an expired cache item,
+while a stale cached response is returned to the client.
+Note that it is necessary to
+<link id="proxy_cache_use_stale_updating">allow</link>
+the usage of a stale cached response when it is being updated.
+</para>
+
+</directive>
+
+
 <directive name="proxy_cache_bypass">
 <syntax><value>string</value> ...</syntax>
 <default/>
@@ -631,7 +651,7 @@
 cannot be selected.
 </para>
 
-<para>
+<para id="proxy_cache_use_stale_updating">
 Additionally, the <literal>updating</literal> parameter permits
 using a stale cached response if it is currently being updated.
 This allows minimizing the number of accesses to proxied servers
diff -r d6692a78a444 -r 399d0e188195 xml/en/docs/http/ngx_http_scgi_module.xml
--- a/xml/en/docs/http/ngx_http_scgi_module.xml	Tue Feb 14 18:46:35 2017 +0300
+++ b/xml/en/docs/http/ngx_http_scgi_module.xml	Wed Feb 15 23:16:54 2017 +0300
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_scgi_module"
         link="/en/docs/http/ngx_http_scgi_module.html"
         lang="en"
-        rev="29">
+        rev="30">
 
 <section id="summary">
 
@@ -193,6 +193,26 @@
 </directive>
 
 
+<directive name="scgi_cache_background_update">
+<syntax><literal>on</literal> | <literal>off</literal></syntax>
+<default>off</default>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+<appeared-in>1.11.10</appeared-in>
+
+<para>
+Allows starting a background subrequest
+to update an expired cache item,
+while a stale cached response is returned to the client.
+Note that it is necessary to
+<link id="scgi_cache_use_stale_updating">allow</link>
+the usage of a stale cached response when it is being updated.
+</para>
+
+</directive>
+
+
 <directive name="scgi_cache_bypass">
 <syntax><value>string</value> ...</syntax>
 <default/>
@@ -604,7 +624,7 @@
 cannot be selected.
 </para>
 
-<para>
+<para id="scgi_cache_use_stale_updating">
 Additionally, the <literal>updating</literal> parameter permits
 using a stale cached response if it is currently being updated.
 This allows minimizing the number of accesses to SCGI servers
diff -r d6692a78a444 -r 399d0e188195 xml/en/docs/http/ngx_http_uwsgi_module.xml
--- a/xml/en/docs/http/ngx_http_uwsgi_module.xml	Tue Feb 14 18:46:35 2017 +0300
+++ b/xml/en/docs/http/ngx_http_uwsgi_module.xml	Wed Feb 15 23:16:54 2017 +0300
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_uwsgi_module"
         link="/en/docs/http/ngx_http_uwsgi_module.html"
         lang="en"
-        rev="32">
+        rev="33">
 
 <section id="summary">
 
@@ -193,6 +193,26 @@
 </directive>
 
 
+<directive name="uwsgi_cache_background_update">
+<syntax><literal>on</literal> | <literal>off</literal></syntax>
+<default>off</default>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+<appeared-in>1.11.10</appeared-in>
+
+<para>
+Allows starting a background subrequest
+to update an expired cache item,
+while a stale cached response is returned to the client.
+Note that it is necessary to
+<link id="uwsgi_cache_use_stale_updating">allow</link>
+the usage of a stale cached response when it is being updated.
+</para>
+
+</directive>
+
+
 <directive name="uwsgi_cache_bypass">
 <syntax><value>string</value> ...</syntax>
 <default/>
@@ -604,7 +624,7 @@
 cannot be selected.
 </para>
 
-<para>
+<para id="uwsgi_cache_use_stale_updating">
 Additionally, the <literal>updating</literal> parameter permits
 using a stale cached response if it is currently being updated.
 This allows minimizing the number of accesses to uwsgi servers
diff -r d6692a78a444 -r 399d0e188195 xml/ru/docs/http/ngx_http_fastcgi_module.xml
--- a/xml/ru/docs/http/ngx_http_fastcgi_module.xml	Tue Feb 14 18:46:35 2017 +0300
+++ b/xml/ru/docs/http/ngx_http_fastcgi_module.xml	Wed Feb 15 23:16:54 2017 +0300
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_fastcgi_module"
         link="/ru/docs/http/ngx_http_fastcgi_module.html"
         lang="ru"
-        rev="40">
+        rev="41">
 
 <section id="summary">
 
@@ -201,6 +201,26 @@
 </directive>
 
 
+<directive name="fastcgi_cache_background_update">
+<syntax><literal>on</literal> | <literal>off</literal></syntax>
+<default>off</default>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+<appeared-in>1.11.10</appeared-in>
+
+<para>
+Позволяет запустить фоновый подзапрос
+для обновления просроченного элемента кэша,
+в то время как клиенту возвращается устаревший закэшированный ответ.
+Использование устаревшего закэшированного ответа в момент его обновления
+должно быть
+<link id="fastcgi_cache_use_stale_updating">разрешено</link>.
+</para>
+
+</directive>
+
+
 <directive name="fastcgi_cache_bypass">
 <syntax><value>строка</value> ...</syntax>
 <default/>
@@ -612,7 +632,7 @@
 FastCGI-сервера для обработки запроса.
 </para>
 
-<para>
+<para id="fastcgi_cache_use_stale_updating">
 Кроме того, дополнительный параметр <literal>updating</literal>
 разрешает использовать устаревший закэшированный ответ,
 если на данный момент он уже обновляется.
diff -r d6692a78a444 -r 399d0e188195 xml/ru/docs/http/ngx_http_proxy_module.xml
--- a/xml/ru/docs/http/ngx_http_proxy_module.xml	Tue Feb 14 18:46:35 2017 +0300
+++ b/xml/ru/docs/http/ngx_http_proxy_module.xml	Wed Feb 15 23:16:54 2017 +0300
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_proxy_module"
         link="/ru/docs/http/ngx_http_proxy_module.html"
         lang="ru"
-        rev="54">
+        rev="55">
 
 <section id="summary">
 
@@ -195,6 +195,26 @@
 </directive>
 
 
+<directive name="proxy_cache_background_update">
+<syntax><literal>on</literal> | <literal>off</literal></syntax>
+<default>off</default>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+<appeared-in>1.11.10</appeared-in>
+
+<para>
+Позволяет запустить фоновый подзапрос
+для обновления просроченного элемента кэша,
+в то время как клиенту возвращается устаревший закэшированный ответ.
+Использование устаревшего закэшированного ответа в момент его обновления
+должно быть
+<link id="proxy_cache_use_stale_updating">разрешено</link>.
+</para>
+
+</directive>
+
+
 <directive name="proxy_cache_bypass">
 <syntax><value>строка</value> ...</syntax>
 <default/>
@@ -632,7 +652,7 @@
 проксированного сервера для обработки запроса.
 </para>
 
-<para>
+<para id="proxy_cache_use_stale_updating">
 Кроме того, дополнительный параметр <literal>updating</literal>
 разрешает использовать устаревший закэшированный ответ,
 если на данный момент он уже обновляется.
diff -r d6692a78a444 -r 399d0e188195 xml/ru/docs/http/ngx_http_scgi_module.xml
--- a/xml/ru/docs/http/ngx_http_scgi_module.xml	Tue Feb 14 18:46:35 2017 +0300
+++ b/xml/ru/docs/http/ngx_http_scgi_module.xml	Wed Feb 15 23:16:54 2017 +0300
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_scgi_module"
         link="/ru/docs/http/ngx_http_scgi_module.html"
         lang="ru"
-        rev="29">
+        rev="30">
 
 <section id="summary">
 
@@ -193,6 +193,26 @@
 </directive>
 
 
+<directive name="scgi_cache_background_update">
+<syntax><literal>on</literal> | <literal>off</literal></syntax>
+<default>off</default>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+<appeared-in>1.11.10</appeared-in>
+
+<para>
+Позволяет запустить фоновый подзапрос
+для обновления просроченного элемента кэша,
+в то время как клиенту возвращается устаревший закэшированный ответ.
+Использование устаревшего закэшированного ответа в момент его обновления
+должно быть
+<link id="scgi_cache_use_stale_updating">разрешено</link>.
+</para>
+
+</directive>
+
+
 <directive name="scgi_cache_bypass">
 <syntax><value>строка</value> ...</syntax>
 <default/>
@@ -603,7 +623,7 @@
 SCGI-сервера для обработки запроса.
 </para>
 
-<para>
+<para id="scgi_cache_use_stale_updating">
 Кроме того, дополнительный параметр <literal>updating</literal>
 разрешает использовать устаревший закэшированный ответ,
 если на данный момент он уже обновляется.
diff -r d6692a78a444 -r 399d0e188195 xml/ru/docs/http/ngx_http_uwsgi_module.xml
--- a/xml/ru/docs/http/ngx_http_uwsgi_module.xml	Tue Feb 14 18:46:35 2017 +0300
+++ b/xml/ru/docs/http/ngx_http_uwsgi_module.xml	Wed Feb 15 23:16:54 2017 +0300
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_uwsgi_module"
         link="/ru/docs/http/ngx_http_uwsgi_module.html"
         lang="ru"
-        rev="32">
+        rev="33">
 
 <section id="summary">
 
@@ -192,6 +192,26 @@
 </directive>
 
 
+<directive name="uwsgi_cache_background_update">
+<syntax><literal>on</literal> | <literal>off</literal></syntax>
+<default>off</default>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+<appeared-in>1.11.10</appeared-in>
+
+<para>
+Позволяет запустить фоновый подзапрос
+для обновления просроченного элемента кэша,
+в то время как клиенту возвращается устаревший закэшированный ответ.
+Использование устаревшего закэшированного ответа в момент его обновления
+должно быть
+<link id="uwsgi_cache_use_stale_updating">разрешено</link>.
+</para>
+
+</directive>
+
+
 <directive name="uwsgi_cache_bypass">
 <syntax><value>строка</value> ...</syntax>
 <default/>
@@ -602,7 +622,7 @@
 uwsgi-сервера для обработки запроса.
 </para>
 
-<para>
+<para id="uwsgi_cache_use_stale_updating">
 Кроме того, дополнительный параметр <literal>updating</literal>
 разрешает использовать устаревший закэшированный ответ,
 если на данный момент он уже обновляется.