linux-kernel - Re: [PATCH v4 0/2] Documentation: doc-guide: Add missing page titles

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <87sfqrectt.fsf@meer.lwn.net>
Date:   Tue, 05 Apr 2022 10:04:30 -0600
From:   Jonathan Corbet <corbet@....net>
To:     Bagas Sanjaya <bagasdotme@...il.com>, linux-doc@...r.kernel.org
Cc:     Bagas Sanjaya <bagasdotme@...il.com>,
        "David S. Miller" <davem@...emloft.net>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        Tony Nguyen <anthony.l.nguyen@...el.com>,
        Vinod Koul <vkoul@...nel.org>,
        Daniel Borkmann <daniel@...earbox.net>,
        Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
        Akira Yokosawa <akiyks@...il.com>,
        "Rafael J. Wysocki" <rafael.j.wysocki@...el.com>,
        Jens Axboe <axboe@...nel.dk>, linux-kernel@...r.kernel.org
Subject: Re: [PATCH v4 0/2] Documentation: doc-guide: Add missing page titles

Bagas Sanjaya <bagasdotme@...il.com> writes:

> The kernel documentation guidelines [1] lists that there should have page
> title.
>
> Add missing page title for kernel-doc.rst and sphinx.rst, in accordance
> to the guideline.
>
> Changes since v3 [2]:
>   - Clarify that there is no output differences except formatting
>     semantics in [1/2]
>   - Drop Suggested-by trailer from Akira Yokosawa in [1/2] 
>
> [1]: https://docs.kernel.org/doc-guide/sphinx.html#specific-guidelines-for-the-kernel-documentation
> [2]:
> https://lore.kernel.org/linux-doc/20220328065030.24936-1-bagasdotme@gmail.com/
>
> Bagas Sanjaya (2):
>   Documentation: kernel-doc: Promote two chapter headings to page title
>   Documentation: sphinx: replace "Introduction" chapter heading with
>     page title
>
>  Documentation/doc-guide/kernel-doc.rst | 2 ++
>  Documentation/doc-guide/sphinx.rst     | 5 +++--
>  2 files changed, 5 insertions(+), 2 deletions(-)

OK, I think this improves the situation overall, so I've applied these,
thanks.

jon