linux-kernel - Re: [PATCH v3 1/2] Documentation: kernel-doc: Promote two chapter headings to page title

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 for Android: free password hash cracker in your pocket

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

Message-ID: <6a5ce717-cc0a-9b7c-ba08-88e3b9f760bb@gmail.com>
Date:   Mon, 28 Mar 2022 16:46:16 +0900
From:   Akira Yokosawa <akiyks@...il.com>
To:     Bagas Sanjaya <bagasdotme@...il.com>
Cc:     Jonathan Corbet <corbet@....net>,
        "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>,
        "Rafael J. Wysocki" <rafael.j.wysocki@...el.com>,
        Jens Axboe <axboe@...nel.dk>, linux-kernel@...r.kernel.org,
        linux-doc@...r.kernel.org, Akira Yokosawa <akiyks@...il.com>
Subject: Re: [PATCH v3 1/2] Documentation: kernel-doc: Promote two chapter
 headings to page title

On Mon, 28 Mar 2022 13:50:30 +0700,
Bagas Sanjaya wrote:
> Promote two chapter headings, named "Writing kernel-doc comments" and
> "Including kernel-doc comments" to page title. These titles deserve
> their own chapters in PDF output, although these will also appear as two
> separate titles in table of contents in HTML output.

As Mauro and I have pointed out, this change won't have any effect
in the resulting HTML and PDF docs.  No difference *at all*.

Why do you think this change is worthwhile.

Please convince us!

> 
> Cc: Jonathan Corbet <corbet@....net>
> Cc: "David S. Miller" <davem@...emloft.net>
> Cc: Greg Kroah-Hartman <gregkh@...uxfoundation.org>
> Cc: Tony Nguyen <anthony.l.nguyen@...el.com>
> Cc: Vinod Koul <vkoul@...nel.org>
> Cc: Daniel Borkmann <daniel@...earbox.net>
> Cc: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
> Cc: Akira Yokosawa <akiyks@...il.com>
> Cc: "Rafael J. Wysocki" <rafael.j.wysocki@...el.com>
> Cc: Jens Axboe <axboe@...nel.dk>
> Cc: linux-kernel@...r.kernel.org
> Suggested-by: Akira Yokosawa <akiyks@...il.com>

Please don't put this Suggested-by: at the moment.

        Thanks, Akira

> Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>
> ---
>  Documentation/doc-guide/kernel-doc.rst | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst
> index 79aaa55d6bcf2b..a7cb2afd799007 100644
> --- a/Documentation/doc-guide/kernel-doc.rst
> +++ b/Documentation/doc-guide/kernel-doc.rst
> @@ -1,3 +1,4 @@
> +===========================
>  Writing kernel-doc comments
>  ===========================
>  
> @@ -436,6 +437,7 @@ The title following ``DOC:`` acts as a heading within the source file, but also
>  as an identifier for extracting the documentation comment. Thus, the title must
>  be unique within the file.
>  
> +=============================
>  Including kernel-doc comments
>  =============================
>