Hello!

On Tue, Aug 29, 2023 at 06:28:09PM +0300, Sergey A. Osokin wrote:

> # HG changeset patch
> # User Sergey A. Osokin <osa@FreeBSD.org.ru>
> # Date 1693322780 -10800
> # Tue Aug 29 18:26:20 2023 +0300
> # Node ID e3b7490c492c7865baf950e20f0430cf035b6cf3
> # Parent 4e25281328fa2152cadedc52e05f8a1b1bf531cd
> Provided more details about ssl_protocol directive usage by
> adding link to the "Server names" document.

Please follow style as outlined at
http://nginx.org/en/docs/contributing_changes.html:

: The commit message should have a single-line synopsis followed
: by verbose description after an empty line. It is desirable that
: the first line is no longer than 67 symbols.

>
> diff -r 4e25281328fa -r e3b7490c492c 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 18:26:20 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">
>
> @@ -616,6 +616,12 @@
> </note>
> </para>
>
> +<para>
> +The directive usage details with virtual servers are provided in the
> +“<link doc="server_names.xml" id="virtual_server_selection">Virtual
> +server selection</link>” section.
> +</para>
> +
> </directive>

I would rather follow generic form of the reference, such as in
http://nginx.org/r/merge_slashes and other directives mentioned in
the section. Probably with some additional clarification, such as
"will be used" instead of "can be used".

In particular, this will make translation trivial (which is also
desired for Russian language, which we used to maintain in the
up-to-date state).

Also, this probably should be before notes, which apply to the
whole directive description and not the particular paragraph.

--
Maxim Dounin
http://mdounin.ru/
_______________________________________________
nginx-devel mailing list
nginx-devel@nginx.org
https://mailman.nginx.org/mailman/listinfo/nginx-devel