[PATCH] Documented the "ipv4=off" parameter of the "resolver" directive
Yaroslav Zhuravlev
yar at nginx.com
Fri Jul 15 11:49:42 UTC 2022
[...]
>> +<para id="resolver_ipv4">
>> +If looking up of IPv4 addresses is not desired,
>> +the <literal>ipv4=off</literal> parameter can be specified (1.23.1).
>> +</para>
>
> Shouldn't it be in the same paragraph which describes the default
> behaviour ("both IPv4 and IPv6 addresses") and "ipv6=off"?
>
> It might be also a good idea to describe "ipv6=off" and
> "ipv4=off" in one sentence instead of repeating the same phrase
> twice.
>
Hi Maxim,
Thank you for your feedback, the patch reworked, in the new version the changes are minimal if compared to the current doc:
# HG changeset patch
# User Yaroslav Zhuravlev <yar at nginx.com>
# Date 1657884682 -3600
# Fri Jul 15 12:31:22 2022 +0100
# Node ID eba78fc7fe66c1d1a51064c509a11945bb6ef8a4
# Parent 9172cf4d2713b685d6956810e5fcad4c29881637
Documented the "ipv4=off" parameter of the "resolver" directive.
diff --git a/xml/en/docs/http/ngx_http_core_module.xml b/xml/en/docs/http/ngx_http_core_module.xml
--- 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="99">
+ rev="100">
<section id="directives" name="Directives">
@@ -2181,6 +2181,7 @@
<value>address</value> ...
[<literal>valid</literal>=<value>time</value>]
[<literal>ipv6</literal>=<literal>on</literal>|<literal>off</literal>]
+ [<literal>ipv4</literal>=<literal>on</literal>|<literal>off</literal>]
[<literal>status_zone</literal>=<value>zone</value>]</syntax>
<default/>
<context>http</context>
@@ -2206,8 +2207,9 @@
<para id="resolver_ipv6">
By default, nginx will look up both IPv4 and IPv6 addresses while resolving.
-If looking up of IPv6 addresses is not desired,
-the <literal>ipv6=off</literal> parameter can be specified.
+If looking up of any part of these addresses is not desired,
+the <literal>ipv6=off</literal> or
+the <literal>ipv4=off</literal> (1.23.1) parameter can be specified.
<note>
Resolving of names into IPv6 addresses is supported
starting from version 1.5.8.
diff --git a/xml/en/docs/mail/ngx_mail_core_module.xml b/xml/en/docs/mail/ngx_mail_core_module.xml
--- a/xml/en/docs/mail/ngx_mail_core_module.xml
+++ b/xml/en/docs/mail/ngx_mail_core_module.xml
@@ -10,7 +10,7 @@
<module name="Module ngx_mail_core_module"
link="/en/docs/mail/ngx_mail_core_module.html"
lang="en"
- rev="19">
+ rev="20">
<section id="summary">
@@ -314,6 +314,7 @@
<value>address</value> ...
[<literal>valid</literal>=<value>time</value>]
[<literal>ipv6</literal>=<literal>on</literal>|<literal>off</literal>]
+ [<literal>ipv4</literal>=<literal>on</literal>|<literal>off</literal>]
[<literal>status_zone</literal>=<value>zone</value>]</syntax>
<syntax><literal>off</literal></syntax>
<default>off</default>
@@ -344,8 +345,9 @@
<para id="resolver_ipv6">
By default, nginx will look up both IPv4 and IPv6 addresses while resolving.
-If looking up of IPv6 addresses is not desired,
-the <literal>ipv6=off</literal> parameter can be specified.
+If looking up of any part of these addresses is not desired,
+the <literal>ipv6=off</literal> or
+the <literal>ipv4=off</literal> (1.23.1) parameter can be specified.
<note>
Resolving of names into IPv6 addresses is supported
starting from version 1.5.8.
diff --git a/xml/en/docs/stream/ngx_stream_core_module.xml b/xml/en/docs/stream/ngx_stream_core_module.xml
--- a/xml/en/docs/stream/ngx_stream_core_module.xml
+++ b/xml/en/docs/stream/ngx_stream_core_module.xml
@@ -9,7 +9,7 @@
<module name="Module ngx_stream_core_module"
link="/en/docs/stream/ngx_stream_core_module.html"
lang="en"
- rev="34">
+ rev="35">
<section id="summary">
@@ -342,6 +342,7 @@
<value>address</value> ...
[<literal>valid</literal>=<value>time</value>]
[<literal>ipv6</literal>=<literal>on</literal>|<literal>off</literal>]
+ [<literal>ipv4</literal>=<literal>on</literal>|<literal>off</literal>]
[<literal>status_zone</literal>=<value>zone</value>]</syntax>
<default/>
<context>stream</context>
@@ -362,8 +363,9 @@
<para id="resolver_ipv6">
By default, nginx will look up both IPv4 and IPv6 addresses while resolving.
-If looking up of IPv6 addresses is not desired,
-the <literal>ipv6=off</literal> parameter can be specified.
+If looking up of any part of these addresses is not desired,
+the <literal>ipv6=off</literal> or
+the <literal>ipv4=off</literal> (1.23.1) parameter can be specified.
</para>
<para id="resolver_valid">
diff --git a/xml/ru/docs/http/ngx_http_core_module.xml b/xml/ru/docs/http/ngx_http_core_module.xml
--- 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="99">
+ rev="100">
<section id="directives" name="Директивы">
@@ -2178,6 +2178,7 @@
<value>адрес</value> ...
[<literal>valid</literal>=<value>время</value>]
[<literal>ipv6</literal>=<literal>on</literal>|<literal>off</literal>]
+ [<literal>ipv4</literal>=<literal>on</literal>|<literal>off</literal>]
[<literal>status_zone</literal>=<value>зона</value>]</syntax>
<default/>
<context>http</context>
@@ -2204,8 +2205,9 @@
<para id="resolver_ipv6">
По умолчанию nginx будет искать как IPv4-, так и IPv6-адреса
при преобразовании имён в адреса.
-Если поиск IPv6-адресов нежелателен,
-можно указать параметр <literal>ipv6=off</literal>.
+Если поиск части адресов нежелателен,
+можно указать параметр <literal>ipv6=off</literal>
+или <literal>ipv4=off</literal> (1.23.1).
<note>
Преобразование имён в IPv6-адреса поддерживается
начиная с версии 1.5.8.
diff --git a/xml/ru/docs/mail/ngx_mail_core_module.xml b/xml/ru/docs/mail/ngx_mail_core_module.xml
--- a/xml/ru/docs/mail/ngx_mail_core_module.xml
+++ b/xml/ru/docs/mail/ngx_mail_core_module.xml
@@ -10,7 +10,7 @@
<module name="Модуль ngx_mail_core_module"
link="/ru/docs/mail/ngx_mail_core_module.html"
lang="ru"
- rev="19">
+ rev="20">
<section id="summary">
@@ -317,6 +317,7 @@
<value>адрес</value> ...
[<literal>valid</literal>=<value>time</value>]
[<literal>ipv6</literal>=<literal>on</literal>|<literal>off</literal>]
+ [<literal>ipv4</literal>=<literal>on</literal>|<literal>off</literal>]
[<literal>status_zone</literal>=<value>зона</value>]</syntax>
<syntax><literal>off</literal></syntax>
<default>off</default>
@@ -348,8 +349,9 @@
<para id="resolver_ipv6">
По умолчанию nginx будет искать как IPv4-, так и IPv6-адреса
при преобразовании имён в адреса.
-Если поиск IPv6-адресов нежелателен,
-можно указать параметр <literal>ipv6=off</literal>.
+Если поиск части адресов нежелателен,
+можно указать параметр <literal>ipv6=off</literal>
+или <literal>ipv4=off</literal> (1.23.1).
<note>
Преобразование имён в IPv6-адреса поддерживается
начиная с версии 1.5.8.
diff --git a/xml/ru/docs/stream/ngx_stream_core_module.xml b/xml/ru/docs/stream/ngx_stream_core_module.xml
--- a/xml/ru/docs/stream/ngx_stream_core_module.xml
+++ b/xml/ru/docs/stream/ngx_stream_core_module.xml
@@ -9,7 +9,7 @@
<module name="Модуль ngx_stream_core_module"
link="/ru/docs/stream/ngx_stream_core_module.html"
lang="ru"
- rev="34">
+ rev="35">
<section id="summary">
@@ -347,6 +347,7 @@
<value>адрес</value> ...
[<literal>valid</literal>=<value>время</value>]
[<literal>ipv6</literal>=<literal>on</literal>|<literal>off</literal>]
+ [<literal>ipv4</literal>=<literal>on</literal>|<literal>off</literal>]
[<literal>status_zone</literal>=<value>зона</value>]</syntax>
<default/>
<context>stream</context>
@@ -368,8 +369,9 @@
<para id="resolver_ipv6">
По умолчанию nginx будет искать как IPv4-, так и IPv6-адреса
при преобразовании имён в адреса.
-Если поиск IPv6-адресов нежелателен,
-можно указать параметр <literal>ipv6=off</literal>.
+Если поиск части адресов нежелателен,
+можно указать параметр <literal>ipv6=off</literal>
+или <literal>ipv4=off</literal> (1.23.1).
</para>
<para id="resolver_valid">
[...]
More information about the nginx-devel
mailing list