changeset 769:d71e56d56ada

Documented variables relocations between http log and core modules.
author Vladimir Homutov <vl@nginx.com>
date Mon, 19 Nov 2012 14:53:54 +0000
parents f63b7fa3bf17
children a879f261f3db
files xml/en/docs/http/ngx_http_core_module.xml xml/en/docs/http/ngx_http_log_module.xml xml/ru/docs/http/ngx_http_core_module.xml xml/ru/docs/http/ngx_http_log_module.xml
diffstat 4 files changed, 82 insertions(+), 26 deletions(-) [+]
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="10">
+        rev="11">
 
 <section id="directives" name="Directives">
 
@@ -2705,7 +2705,25 @@ client address in a binary form, value’s length is always 4 bytes
 
 <tag-name id="var_body_bytes_sent"><var>$body_bytes_sent</var></tag-name>
 <tag-desc>
-number of bytes sent to a client, not counting the response header
+number of bytes sent to a client, not counting the response header;
+this variable is compatible with the “<literal>%B</literal>” parameter of the
+<literal>mod_log_config</literal>
+Apache module
+</tag-desc>
+
+<tag-name id="var_bytes_sent"><var>$bytes_sent</var></tag-name>
+<tag-desc>
+number of bytes sent to a client (1.3.8, 1.2.5)
+</tag-desc>
+
+<tag-name id="var_connection"><var>$connection</var></tag-name>
+<tag-desc>
+connection serial number (1.3.8, 1.2.5)
+</tag-desc>
+
+<tag-name id="var_connection_requests"><var>$connection_requests</var></tag-name>
+<tag-desc>
+current number of requests made through a connection (1.3.8, 1.2.5)
 </tag-desc>
 
 <tag-name id="var_content_length"><var>$content_length</var></tag-name>
@@ -2912,7 +2930,7 @@ or
 
 <tag-name id="var_status"><var>$status</var></tag-name>
 <tag-desc>
-response status
+response status (1.3.2, 1.2.2)
 </tag-desc>
 
 <tag-name id="var_tcpinfo_">
--- a/xml/en/docs/http/ngx_http_log_module.xml
+++ b/xml/en/docs/http/ngx_http_log_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_log_module"
         link="/en/docs/http/ngx_http_log_module.html"
         lang="en"
-        rev="3">
+        rev="4">
 
 <section id="summary">
 
@@ -136,27 +136,32 @@ The log format can contain common variab
 exist only at the time of a log write:
 <list type="tag">
 
-<tag-name><var>$body_bytes_sent</var></tag-name>
-<tag-desc>
-the number of bytes sent to a client not counting the response header;
-this variable is compatible with the “<literal>%B</literal>” parameter of the
-<literal>mod_log_config</literal>
-Apache module
-</tag-desc>
-
 <tag-name><var>$bytes_sent</var></tag-name>
 <tag-desc>
 the number of bytes sent to a client
+<note>
+Since versions 1.3.8 and 1.2.5 there is a common variable with the
+<link doc="ngx_http_core_module.xml" id="var_bytes_sent">same name</link>.
+</note>
 </tag-desc>
 
 <tag-name><var>$connection</var></tag-name>
 <tag-desc>
 connection serial number
+<note>
+Since versions 1.3.8 and 1.2.5 there is a common variable with the
+<link doc="ngx_http_core_module.xml" id="var_connection">same name</link>.
+</note>
 </tag-desc>
 
 <tag-name><var>$connection_requests</var></tag-name>
 <tag-desc>
-the current number of requests made through a connection
+the current number of requests made through a connection (1.1.18)
+<note>
+Since versions 1.3.8 and 1.2.5 there is a common variable with the
+<link doc="ngx_http_core_module.xml" id="var_connection_requests">same
+name</link>.
+</note>
 </tag-desc>
 
 <tag-name><var>$msec</var></tag-name>
@@ -185,6 +190,10 @@ the log write after the last bytes were 
 <tag-name><var>$status</var></tag-name>
 <tag-desc>
 response status
+<note>
+Since versions 1.3.2 and 1.2.2 there is a common variable with the
+<link doc="ngx_http_core_module.xml" id="var_status">same name</link>.
+</note>
 </tag-desc>
 
 <tag-name><var>$time_iso8601</var></tag-name>
--- 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="10">
+        rev="11">
 
 <section id="directives" name="Директивы">
 
@@ -2693,7 +2693,24 @@ location /download/ {
 
 <tag-name id="var_body_bytes_sent"><var>$body_bytes_sent</var></tag-name>
 <tag-desc>
-число байт, переданное клиенту, без учёта заголовка ответа
+число байт, переданное клиенту, без учёта заголовка ответа;
+переменная совместима с параметром “<literal>%B</literal>” модуля Apache
+<literal>mod_log_config</literal>
+</tag-desc>
+
+<tag-name id="var_bytes_sent"><var>$bytes_sent</var></tag-name>
+<tag-desc>
+число байт, переданное клиенту (1.3.8, 1.2.5)
+</tag-desc>
+
+<tag-name id="var_connection"><var>$connection</var></tag-name>
+<tag-desc>
+порядковый номер соединения (1.3.8, 1.2.5)
+</tag-desc>
+
+<tag-name id="var_connection_requests"><var>$connection_requests</var></tag-name>
+<tag-desc>
+текущее число запросов в соединении (1.3.8, 1.2.5)
 </tag-desc>
 
 <tag-name id="var_content_length"><var>$content_length</var></tag-name>
@@ -2898,7 +2915,7 @@ fastcgi_pass_request_body off</link>
 
 <tag-name id="var_status"><var>$status</var></tag-name>
 <tag-desc>
-статус ответа
+статус ответа (1.3.2, 1.2.2)
 </tag-desc>
 
 <tag-name id="var_tcpinfo_">
--- a/xml/ru/docs/http/ngx_http_log_module.xml
+++ b/xml/ru/docs/http/ngx_http_log_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_log_module"
         link="/ru/docs/http/ngx_http_log_module.html"
         lang="ru"
-        rev="3">
+        rev="4">
 
 <section id="summary">
 
@@ -134,26 +134,34 @@ server {
 существующие только на момент записи в лог:
 <list type="tag">
 
-<tag-name><var>$body_bytes_sent</var></tag-name>
-<tag-desc>
-число байт, переданных клиенту, за вычетом заголовка ответа;
-переменная совместима с параметром “<literal>%B</literal>” модуля Apache
-<literal>mod_log_config</literal>
-</tag-desc>
-
 <tag-name><var>$bytes_sent</var></tag-name>
 <tag-desc>
-число байт, переданных клиенту
+число байт, переданное клиенту
+<note>
+Начиная с версий 1.3.8 и 1.2.5 существует общая переменная с
+<link doc="ngx_http_core_module.xml" id="var_bytes_sent">тем же
+именем</link>.
+</note>
 </tag-desc>
 
 <tag-name><var>$connection</var></tag-name>
 <tag-desc>
 порядковый номер соединения
+<note>
+Начиная с версий 1.3.8 и 1.2.5 существует общая переменная с
+<link doc="ngx_http_core_module.xml" id="var_connection">тем же
+именем</link>.
+</note>
 </tag-desc>
 
 <tag-name><var>$connection_requests</var></tag-name>
 <tag-desc>
-текущее число запросов в соединении
+текущее число запросов в соединении (1.1.18)
+<note>
+Начиная с версий 1.3.8 и 1.2.5 существует общая переменная с
+<link doc="ngx_http_core_module.xml" id="var_connection_requests">тем же
+именем</link>.
+</note>
 </tag-desc>
 
 <tag-name><var>$msec</var></tag-name>
@@ -181,6 +189,10 @@ server {
 <tag-name><var>$status</var></tag-name>
 <tag-desc>
 статус ответа
+<note>
+Начиная с версий 1.3.2 и 1.2.2 существует общая переменная с
+<link doc="ngx_http_core_module.xml" id="var_status">тем же именем</link>.
+</note>
 </tag-desc>
 
 <tag-name><var>$time_iso8601</var></tag-name>