changeset 2068:3d9e7993c201

Added links to directives in the example of ssl modules.
author Yaroslav Zhuravlev <yar@nginx.com>
date Mon, 23 Oct 2017 14:48:21 +0300
parents 014323d0cc38
children fc3ba2e76974
files xml/en/docs/http/ngx_http_ssl_module.xml xml/en/docs/mail/ngx_mail_ssl_module.xml xml/en/docs/stream/ngx_stream_ssl_module.xml xml/ru/docs/http/ngx_http_ssl_module.xml xml/ru/docs/mail/ngx_mail_ssl_module.xml xml/ru/docs/stream/ngx_stream_ssl_module.xml
diffstat 6 files changed, 72 insertions(+), 50 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_ssl_module.xml
+++ b/xml/en/docs/http/ngx_http_ssl_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_ssl_module"
         link="/en/docs/http/ngx_http_ssl_module.html"
         lang="en"
-        rev="36">
+        rev="37">
 
 <section id="summary">
 
@@ -39,23 +39,28 @@ To reduce the processor load it is recom
 <list type="bullet">
 
 <listitem>
-set the number of worker processes equal to the number of processors,
-</listitem>
-
-<listitem>
-enable keep-alive connections,
+set the number of
+<link doc="../ngx_core_module.xml" id="worker_processes">worker processes</link>
+equal to the number of processors,
 </listitem>
 
 <listitem>
-enable the shared session cache,
+enable
+<link doc="ngx_http_core_module.xml" id="keepalive_timeout">keep-alive</link>
+connections,
 </listitem>
 
 <listitem>
-disable the built-in session cache,
+enable the <link id="ssl_session_cache_shared">shared</link> session cache,
 </listitem>
 
 <listitem>
-and possibly increase the session lifetime (by default, 5 minutes):
+disable the <link id="ssl_session_cache_builtin">built-in</link> session cache,
+</listitem>
+
+<listitem>
+and possibly increase the session <link id="ssl_session_timeout">lifetime</link>
+(by default, 5 minutes):
 </listitem>
 
 </list>
@@ -430,7 +435,7 @@ nginx tells a client that sessions may b
 actually store session parameters in the cache.
 </tag-desc>
 
-<tag-name><literal>builtin</literal></tag-name>
+<tag-name id="ssl_session_cache_builtin"><literal>builtin</literal></tag-name>
 <tag-desc>
 a cache built in OpenSSL; used by one worker process only.
 The cache size is specified in sessions.
@@ -438,7 +443,7 @@ If size is not given, it is equal to 204
 Use of the built-in cache can cause memory fragmentation.
 </tag-desc>
 
-<tag-name><literal>shared</literal></tag-name>
+<tag-name id="ssl_session_cache_shared"><literal>shared</literal></tag-name>
 <tag-desc>
 a cache shared between all worker processes.
 The cache size is specified in bytes; one megabyte can store
--- a/xml/en/docs/mail/ngx_mail_ssl_module.xml
+++ b/xml/en/docs/mail/ngx_mail_ssl_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_mail_ssl_module"
         link="/en/docs/mail/ngx_mail_ssl_module.html"
         lang="en"
-        rev="16">
+        rev="17">
 
 <section id="summary">
 
@@ -39,19 +39,22 @@ To reduce the processor load, it is reco
 <list type="bullet">
 
 <listitem>
-set the number of worker processes equal to the number of processors,
+set the number of
+<link doc="../ngx_core_module.xml" id="worker_processes">worker processes</link>
+equal to the number of processors,
 </listitem>
 
 <listitem>
-enable the shared session cache,
+enable the <link id="ssl_session_cache_shared">shared</link> session cache,
 </listitem>
 
 <listitem>
-disable the built-in session cache,
+disable the <link id="ssl_session_cache_builtin">built-in</link> session cache,
 </listitem>
 
 <listitem>
-and possibly increase the session lifetime (by default, 5 minutes):
+and possibly increase the session <link id="ssl_session_timeout">lifetime</link>
+(by default, 5 minutes):
 </listitem>
 
 </list>
@@ -387,7 +390,7 @@ nginx tells a client that sessions may b
 actually store session parameters in the cache.
 </tag-desc>
 
-<tag-name><literal>builtin</literal></tag-name>
+<tag-name id="ssl_session_cache_builtin"><literal>builtin</literal></tag-name>
 <tag-desc>
 a cache built in OpenSSL; used by one worker process only.
 The cache size is specified in sessions.
@@ -395,7 +398,7 @@ If size is not given, it is equal to 204
 Use of the built-in cache can cause memory fragmentation.
 </tag-desc>
 
-<tag-name><literal>shared</literal></tag-name>
+<tag-name id="ssl_session_cache_shared"><literal>shared</literal></tag-name>
 <tag-desc>
 a cache shared between all worker processes.
 The cache size is specified in bytes; one megabyte can store
--- a/xml/en/docs/stream/ngx_stream_ssl_module.xml
+++ b/xml/en/docs/stream/ngx_stream_ssl_module.xml
@@ -9,7 +9,7 @@
 <module name="Module ngx_stream_ssl_module"
         link="/en/docs/stream/ngx_stream_ssl_module.html"
         lang="en"
-        rev="17">
+        rev="18">
 
 <section id="summary">
 
@@ -32,19 +32,22 @@ To reduce the processor load, it is reco
 <list type="bullet">
 
 <listitem>
-set the number of worker processes equal to the number of processors,
+set the number of
+<link doc="../ngx_core_module.xml" id="worker_processes">worker processes</link>
+equal to the number of processors,
 </listitem>
 
 <listitem>
-enable the shared session cache,
+enable the <link id="ssl_session_cache_shared">shared</link> session cache,
 </listitem>
 
 <listitem>
-disable the built-in session cache,
+disable the <link id="ssl_session_cache_builtin">built-in</link> session cache,
 </listitem>
 
 <listitem>
-and possibly increase the session lifetime (by default, 5 minutes):
+and possibly increase the session <link id="ssl_session_timeout">lifetime</link>
+(by default, 5 minutes):
 </listitem>
 
 </list>
@@ -368,7 +371,7 @@ nginx tells a client that sessions may b
 actually store session parameters in the cache.
 </tag-desc>
 
-<tag-name><literal>builtin</literal></tag-name>
+<tag-name id="ssl_session_cache_builtin"><literal>builtin</literal></tag-name>
 <tag-desc>
 a cache built in OpenSSL; used by one worker process only.
 The cache size is specified in sessions.
@@ -376,7 +379,7 @@ If size is not given, it is equal to 204
 Use of the built-in cache can cause memory fragmentation.
 </tag-desc>
 
-<tag-name><literal>shared</literal></tag-name>
+<tag-name id="ssl_session_cache_shared"><literal>shared</literal></tag-name>
 <tag-desc>
 a cache shared between all worker processes.
 The cache size is specified in bytes; one megabyte can store
--- a/xml/ru/docs/http/ngx_http_ssl_module.xml
+++ b/xml/ru/docs/http/ngx_http_ssl_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_ssl_module"
         link="/ru/docs/http/ngx_http_ssl_module.html"
         lang="ru"
-        rev="36">
+        rev="37">
 
 <section id="summary">
 
@@ -39,23 +39,28 @@
 <list type="bullet">
 
 <listitem>
-установить число рабочих процессов равным числу процессоров,
-</listitem>
-
-<listitem>
-разрешить keep-alive соединения,
+установить число
+<link doc="../ngx_core_module.xml" id="worker_processes">рабочих процессов</link>
+равным числу процессоров,
 </listitem>
 
 <listitem>
-включить разделяемый кэш сессий,
+разрешить
+<link doc="ngx_http_core_module.xml" id="keepalive_timeout">keep-alive</link>
+соединения,
 </listitem>
 
 <listitem>
-выключить встроенный кэш сессий
+включить <link id="ssl_session_cache_shared">разделяемый</link> кэш сессий,
 </listitem>
 
 <listitem>
-и, возможно, увеличить время жизни сессии (по умолчанию 5 минут):
+выключить <link id="ssl_session_cache_builtin">встроенный</link> кэш сессий
+</listitem>
+
+<listitem>
+и, возможно, увеличить <link id="ssl_session_timeout">время жизни</link> сессии
+(по умолчанию 5 минут):
 </listitem>
 
 </list>
@@ -432,7 +437,7 @@ nginx сообщает клиенту, что сессии могут использоваться повторно, но
 на самом деле не хранит параметры сессии в кэше.
 </tag-desc>
 
-<tag-name><literal>builtin</literal></tag-name>
+<tag-name id="ssl_session_cache_builtin"><literal>builtin</literal></tag-name>
 <tag-desc>
 встроенный в OpenSSL кэш, используется в рамках только одного рабочего процесса.
 Размер кэша задаётся в сессиях.
@@ -440,7 +445,7 @@ nginx сообщает клиенту, что сессии могут использоваться повторно, но
 Использование встроенного кэша может вести к фрагментации памяти.
 </tag-desc>
 
-<tag-name><literal>shared</literal></tag-name>
+<tag-name id="ssl_session_cache_shared"><literal>shared</literal></tag-name>
 <tag-desc>
 кэш, разделяемый между всеми рабочими процессами.
 Размер кэша задаётся в байтах, в 1 мегабайт может поместиться
--- a/xml/ru/docs/mail/ngx_mail_ssl_module.xml
+++ b/xml/ru/docs/mail/ngx_mail_ssl_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_mail_ssl_module"
         link="/ru/docs/mail/ngx_mail_ssl_module.html"
         lang="ru"
-        rev="16">
+        rev="17">
 
 <section id="summary">
 
@@ -39,19 +39,22 @@
 <list type="bullet">
 
 <listitem>
-установить число рабочих процессов равным числу процессоров,
+установить число
+<link doc="../ngx_core_module.xml" id="worker_processes">рабочих процессов</link>
+равным числу процессоров,
 </listitem>
 
 <listitem>
-включить разделяемый кэш сессий,
+включить <link id="ssl_session_cache_shared">разделяемый</link> кэш сессий,
 </listitem>
 
 <listitem>
-выключить встроенный кэш сессий
+выключить <link id="ssl_session_cache_builtin">встроенный</link> кэш сессий
 </listitem>
 
 <listitem>
-и, возможно, увеличить время жизни сессии (по умолчанию 5 минут):
+и, возможно, увеличить <link id="ssl_session_timeout">время жизни</link> сессии
+(по умолчанию 5 минут):
 </listitem>
 
 </list>
@@ -387,7 +390,7 @@ nginx сообщает клиенту, что сессии могут использоваться повторно, но
 на самом деле не хранит параметры сессии в кэше.
 </tag-desc>
 
-<tag-name><literal>builtin</literal></tag-name>
+<tag-name id="ssl_session_cache_builtin"><literal>builtin</literal></tag-name>
 <tag-desc>
 встроенный в OpenSSL кэш, используется в рамках только одного рабочего процесса.
 Размер кэша задаётся в сессиях.
@@ -395,7 +398,7 @@ nginx сообщает клиенту, что сессии могут использоваться повторно, но
 Использование встроенного кэша может вести к фрагментации памяти.
 </tag-desc>
 
-<tag-name><literal>shared</literal></tag-name>
+<tag-name id="ssl_session_cache_shared"><literal>shared</literal></tag-name>
 <tag-desc>
 кэш, разделяемый между всеми рабочими процессами.
 Размер кэша задаётся в байтах, в 1 мегабайт может поместиться
--- a/xml/ru/docs/stream/ngx_stream_ssl_module.xml
+++ b/xml/ru/docs/stream/ngx_stream_ssl_module.xml
@@ -9,7 +9,7 @@
 <module name="Модуль ngx_stream_ssl_module"
         link="/ru/docs/stream/ngx_stream_ssl_module.html"
         lang="ru"
-        rev="17">
+        rev="18">
 
 <section id="summary">
 
@@ -32,19 +32,22 @@
 <list type="bullet">
 
 <listitem>
-установить число рабочих процессов равным числу процессоров,
+установить число
+<link doc="../ngx_core_module.xml" id="worker_processes">рабочих процессов</link>
+равным числу процессоров,
 </listitem>
 
 <listitem>
-включить разделяемый кэш сессий,
+включить <link id="ssl_session_cache_shared">разделяемый</link> кэш сессий,
 </listitem>
 
 <listitem>
-выключить встроенный кэш сессий
+выключить <link id="ssl_session_cache_builtin">встроенный</link> кэш сессий
 </listitem>
 
 <listitem>
-и, возможно, увеличить время жизни сессии (по умолчанию 5 минут):
+и, возможно, увеличить <link id="ssl_session_timeout">время жизни</link> сессии
+(по умолчанию 5 минут):
 </listitem>
 
 </list>
@@ -368,7 +371,7 @@ nginx сообщает клиенту, что сессии могут использоваться повторно, но
 на самом деле не хранит параметры сессии в кэше.
 </tag-desc>
 
-<tag-name><literal>builtin</literal></tag-name>
+<tag-name id="ssl_session_cache_builtin"><literal>builtin</literal></tag-name>
 <tag-desc>
 встроенный в OpenSSL кэш, используется в рамках только одного рабочего процесса.
 Размер кэша задаётся в сессиях.
@@ -376,7 +379,7 @@ nginx сообщает клиенту, что сессии могут использоваться повторно, но
 Использование встроенного кэша может вести к фрагментации памяти.
 </tag-desc>
 
-<tag-name><literal>shared</literal></tag-name>
+<tag-name id="ssl_session_cache_shared"><literal>shared</literal></tag-name>
 <tag-desc>
 кэш, разделяемый между всеми рабочими процессами.
 Размер кэша задаётся в байтах, в 1 мегабайт может поместиться