[PATCH] Provided more details about ssl_protocol directive usage by

[Sergey A. Osokin]

Hi,

On Tue, Aug 29, 2023 at 09:21:54PM +0300, Maxim Dounin wrote:
> On Tue, Aug 29, 2023 at 08:54:46PM +0300, Sergey A. Osokin wrote:

[...]

> >  <para>
> >  Enables the specified protocols.
> > +
> > +<para>
> 
> $ make
> ...
> xmllint --noout --valid  xml/en/docs/http/ngx_http_ssl_module.xml
> xml/en/docs/http/ngx_http_ssl_module.xml:626: element para: 
> validity error : Element para is not declared in para list of 
> possible children
> </para>
>        ^
> gmake[1]: *** [GNUmakefile:164: 
> libxslt/en/docs/http/ngx_http_ssl_module.html] Error 4
> 
> 
> In this particular case, appropriate solution would be to close 
> the paragraph, and put notes into their own paragraph.

Fixed.

> > +If the directive is specified on the <link id="server"/> level,
> > +the value from the default will be used.
> 
> s/the default/the default server/

Fixed.

> Also, reading it again I tend to think that "will be used" might 
> be misleading.  It might be good to adjust this somehow to make it 
> clear that ssl_protocols works if used in the default server, but 
> will use the configuration from the default server if used in a 
> name-based virtual server.  Not sure how though.
> 
> Alternatively, just using "can be used" as in other directives 
> might be good enough.

I'd prefer to keep "will be used", so I slightly change the 
target, please take a look.

> > +Defails are provided in the
> 
> s/Defails/Details/

Fixed.

> > +виртуального сервера</link>”.
> > +</para>
> > +
> >  <note>
> 
> Same here.

Fixed, here's another revision.

# HG changeset patch
# User Sergey A. Osokin <osa at FreeBSD.org.ru>
# Date 1693338612 -10800
#      Tue Aug 29 22:50:12 2023 +0300
# Node ID e61a21da119d7284b3b93f9a3ab530e1556fae09
# Parent  4e25281328fa2152cadedc52e05f8a1b1bf531cd
Updated ngx_http_ssl_module module documentation.

Provided details about ssl_protocol directive usage by
adding link to the "Server names" document.

diff -r 4e25281328fa -r e61a21da119d xml/en/docs/http/ngx_http_ssl_module.xml
--- a/xml/en/docs/http/ngx_http_ssl_module.xml	Tue Aug 29 09:11:57 2023 +0100
+++ b/xml/en/docs/http/ngx_http_ssl_module.xml	Tue Aug 29 22:50:12 2023 +0300
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_ssl_module"
         link="/en/docs/http/ngx_http_ssl_module.html"
         lang="en"
-        rev="61">
+        rev="62">
 
 <section id="summary">
 
@@ -602,6 +602,18 @@
 
 <para>
 Enables the specified protocols.
+</para>
+
+<para>
+If the directive is specified on the <link id="server"/> level of a
+name-based virtual server, the value from the default server will
+be used.
+Details are provided in the
+“<link doc="server_names.xml" id="virtual_server_selection">Virtual
+server selection</link>” section.
+</para>
+
+<para>
 <note>
 The <literal>TLSv1.1</literal> and <literal>TLSv1.2</literal> parameters
 (1.1.13, 1.0.12) work only when OpenSSL 1.0.1 or higher is used.
diff -r 4e25281328fa -r e61a21da119d xml/ru/docs/http/ngx_http_ssl_module.xml
--- a/xml/ru/docs/http/ngx_http_ssl_module.xml	Tue Aug 29 09:11:57 2023 +0100
+++ b/xml/ru/docs/http/ngx_http_ssl_module.xml	Tue Aug 29 22:50:12 2023 +0300
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_ssl_module"
         link="/ru/docs/http/ngx_http_ssl_module.html"
         lang="ru"
-        rev="61">
+        rev="62">
 
 <section id="summary">
 
@@ -607,6 +607,18 @@
 
 <para>
 Разрешает указанные протоколы.
+</para>
+
+<para>
+Если директива указана на уровне основанного на имени виртуального
+<link id="server"/>, то будет использоваться значение из сервера
+по умолчанию.
+Подробнее см. в разделе
+“<link doc="server_names.xml" id="virtual_server_selection">Выбор
+виртуального сервера</link>”.
+</para>
+
+<para>
 <note>
 Параметры <literal>TLSv1.1</literal> и <literal>TLSv1.2</literal>
 (1.1.13, 1.0.12) работают только при использовании OpenSSL 1.0.1 и выше.


-- 
Sergey A. Osokin