Welcome! Log In Create A New Profile

Advanced

Re: [PATCH] Minor docs fixes

Yaroslav Zhuravlev
August 31, 2023 05:26PM
Hi,

> On 31 Aug 2023, at 21:43, Sergey A. Osokin <osa@freebsd.org.ru> wrote:
>
> Hi,
>
> here's the patch from Ryan.
>
> On Thu, Aug 31, 2023 at 08:31:34PM +0000, Ryan Davis via nginx-devel wrote:
>> Apologies, the corporate SMTP server is doing something unexpected.
>
> # HG changeset patch
> # User Ryan Davis <ry.davis@f5.com>
> # Date 1693509279 14400
> # Thu Aug 31 15:14:39 2023 -0400
> # Node ID 31eebaba6f8d4973c35c40f3da69c9d9fe598438
> # Parent 4e25281328fa2152cadedc52e05f8a1b1bf531cd
> Minor docs fixes

Perhaps a more descriptive commit log would be better, e.g.
"Fixed lang attribute, added module closing tag."

>
> - add a missing close tag that tripped up non-streaming XML parsers
> - fix a misclassified `lang` attribute
>
> diff -r 4e25281328fa -r 31eebaba6f8d xml/en/docs/http/ngx_http_api_module_head.xml
> --- a/xml/en/docs/http/ngx_http_api_module_head.xml Tue Aug 29 09:11:57 2023 +0100
> +++ b/xml/en/docs/http/ngx_http_api_module_head.xml Thu Aug 31 15:14:39 2023 -0400
> @@ -9,7 +9,7 @@
> <module name="Module ngx_http_api_module"
> link="/en/docs/http/ngx_http_api_module.html"
> lang="en"
> - rev="3">
> + rev="4">
>
> <section id="summary">
>
> @@ -298,3 +298,4 @@
> </para>
>
> </section>

Blank line missing between section and module tags.

> +</module>
> diff -r 4e25281328fa -r 31eebaba6f8d xml/ru/docs/http/ngx_http_v3_module.xml
> --- a/xml/ru/docs/http/ngx_http_v3_module.xml Tue Aug 29 09:11:57 2023 +0100
> +++ b/xml/ru/docs/http/ngx_http_v3_module.xml Thu Aug 31 15:14:39 2023 -0400
> @@ -8,8 +8,8 @@
>
> <module name="Модуль ngx_http_v3_module"
> link="/ru/docs/http/ngx_http_v3_module.html"
> - lang="en"
> - rev="2">
> + lang="ru"
> + rev="3">

Version bump should also be applied to the En version as well as they correspond to each other.
Or it might be better not to bump the version at all here as the change is small and not content related.

>
> <section id="summary">
>
>
> --
> Sergey A. Osokin
> _______________________________________________
> nginx-devel mailing list
> nginx-devel@nginx.org
> https://mailman.nginx.org/mailman/listinfo/nginx-devel
_______________________________________________
nginx-devel mailing list
nginx-devel@nginx.org
https://mailman.nginx.org/mailman/listinfo/nginx-devel
Subject Author Views Posted

[PATCH] Minor docs fixes

Ryan Davis via nginx-devel 274 August 31, 2023 04:02PM

Re: [PATCH] Minor docs fixes Attachments

Ryan Davis via nginx-devel 76 August 31, 2023 04:32PM

Re: [PATCH] Minor docs fixes

Sergey A. Osokin 87 August 31, 2023 04:44PM

Re: [PATCH] Minor docs fixes

Yaroslav Zhuravlev 84 August 31, 2023 05:26PM

Re: [PATCH] Minor docs fixes Attachments

Ryan Davis via nginx-devel 72 September 01, 2023 09:02AM

Re: [PATCH] Minor docs fixes

Yaroslav Zhuravlev 100 September 01, 2023 07:12PM



Sorry, you do not have permission to post/reply in this forum.

Online Users

Guests: 296
Record Number of Users: 8 on April 13, 2023
Record Number of Guests: 421 on December 02, 2018
Powered by nginx      Powered by FreeBSD      PHP Powered      Powered by MariaDB      ipv6 ready