changeset 1752:b4de612feff8

Documented the split_clients module in stream.
author Yaroslav Zhuravlev <yar@nginx.com>
date Thu, 14 Jul 2016 20:33:18 +0300
parents 3768eb3d9c6c
children 256774f145ac
files xml/en/GNUmakefile xml/en/docs/index.xml xml/en/docs/stream/ngx_stream_split_clients_module.xml xml/ru/GNUmakefile xml/ru/docs/index.xml xml/ru/docs/stream/ngx_stream_split_clients_module.xml
diffstat 6 files changed, 27 insertions(+), 25 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/GNUmakefile
+++ b/xml/en/GNUmakefile
@@ -102,6 +102,7 @@ REFS =									\
 		stream/ngx_stream_map_module				\
 		stream/ngx_stream_proxy_module				\
 		stream/ngx_stream_return_module				\
+		stream/ngx_stream_split_clients_module			\
 		stream/ngx_stream_ssl_module				\
 		stream/ngx_stream_upstream_module			\
 
--- a/xml/en/docs/index.xml
+++ b/xml/en/docs/index.xml
@@ -8,7 +8,7 @@
 <article name="nginx documentation"
          link="/en/docs/"
          lang="en"
-         rev="28"
+         rev="29"
          toc="no">
 
 
@@ -522,6 +522,11 @@ ngx_stream_return_module</link>
 </listitem>
 
 <listitem>
+<link doc="stream/ngx_stream_split_clients_module.xml">
+ngx_stream_split_clients_module</link>
+</listitem>
+
+<listitem>
 <link doc="stream/ngx_stream_ssl_module.xml">
 ngx_stream_ssl_module</link>
 </listitem>
copy from xml/en/docs/http/ngx_http_split_clients_module.xml
copy to xml/en/docs/stream/ngx_stream_split_clients_module.xml
--- a/xml/en/docs/http/ngx_http_split_clients_module.xml
+++ b/xml/en/docs/stream/ngx_stream_split_clients_module.xml
@@ -1,21 +1,20 @@
 <?xml version="1.0"?>
 
 <!--
-  Copyright (C) Igor Sysoev
   Copyright (C) Nginx, Inc.
   -->
 
 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
 
-<module name="Module ngx_http_split_clients_module"
-        link="/en/docs/http/ngx_http_split_clients_module.html"
+<module name="Module ngx_stream_split_clients_module"
+        link="/en/docs/stream/ngx_stream_split_clients_module.html"
         lang="en"
-        rev="2">
+        rev="1">
 
 <section id="summary">
 
 <para>
-The <literal>ngx_http_split_clients_module</literal> module creates
+The <literal>ngx_stream_split_clients_module</literal> module (1.11.3) creates
 variables suitable for A/B testing, also known as split testing.
 </para>
 
@@ -26,16 +25,12 @@ variables suitable for A/B testing, also
 
 <para>
 <example>
-http {
+stream {
     split_clients "${remote_addr}AAA" $variant {
                    0.5%               .one;
                    2.0%               .two;
                    *                  "";
     }
-
-    server {
-        location / {
-            index index${variant}.html;
 </example>
 </para>
 
@@ -49,7 +44,7 @@ http {
     <value>string</value>
     <value>$variable</value></syntax>
 <default/>
-<context>http</context>
+<context>stream</context>
 
 <para>
 Creates a variable for A/B testing, for example:
--- a/xml/ru/GNUmakefile
+++ b/xml/ru/GNUmakefile
@@ -91,6 +91,7 @@ REFS =									\
 		stream/ngx_stream_map_module				\
 		stream/ngx_stream_proxy_module				\
 		stream/ngx_stream_return_module				\
+		stream/ngx_stream_split_clients_module			\
 		stream/ngx_stream_ssl_module				\
 		stream/ngx_stream_upstream_module			\
 
--- a/xml/ru/docs/index.xml
+++ b/xml/ru/docs/index.xml
@@ -8,7 +8,7 @@
 <article name="nginx: документация"
          link="/ru/docs/"
          lang="ru"
-         rev="28"
+         rev="29"
          toc="no">
 
 
@@ -526,6 +526,11 @@ ngx_stream_return_module</link>
 </listitem>
 
 <listitem>
+<link doc="stream/ngx_stream_split_clients_module.xml">
+ngx_stream_split_clients_module</link>
+</listitem>
+
+<listitem>
 <link doc="stream/ngx_stream_ssl_module.xml">
 ngx_stream_ssl_module</link>
 </listitem>
copy from xml/ru/docs/http/ngx_http_split_clients_module.xml
copy to xml/ru/docs/stream/ngx_stream_split_clients_module.xml
--- a/xml/ru/docs/http/ngx_http_split_clients_module.xml
+++ b/xml/ru/docs/stream/ngx_stream_split_clients_module.xml
@@ -1,22 +1,21 @@
 <?xml version="1.0"?>
 
 <!--
-  Copyright (C) Igor Sysoev
   Copyright (C) Nginx, Inc.
   -->
 
 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
 
-<module name="Модуль ngx_http_split_clients_module"
-        link="/ru/docs/http/ngx_http_split_clients_module.html"
+<module name="Модуль ngx_stream_split_clients_module"
+        link="/ru/docs/stream/ngx_stream_split_clients_module.html"
         lang="ru"
-        rev="2">
+        rev="1">
 
 <section id="summary">
 
 <para>
-Модуль <literal>ngx_http_split_clients_module</literal> создаёт переменные для
-A/B тестирования (также известного как “split-тестирование”).
+Модуль <literal>ngx_stream_split_clients_module</literal> (1.11.3) создаёт
+переменные для A/B тестирования (также известного как “split-тестирование”).
 </para>
 
 </section>
@@ -26,16 +25,12 @@ A/B тестирования (также известного как “split-тестирование”).
 
 <para>
 <example>
-http {
+stream {
     split_clients "${remote_addr}AAA" $variant {
                    0.5%               .one;
                    2.0%               .two;
                    *                  "";
     }
-
-    server {
-        location / {
-            index index${variant}.html;
 </example>
 </para>
 
@@ -49,7 +44,7 @@ http {
     <value>строка</value>
     <value>$переменная</value></syntax>
 <default/>
-<context>http</context>
+<context>stream</context>
 
 <para>
 Создаёт переменную для A/B тестирования, например: