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 <[email protected]>
> Cc: "David S. Miller" <[email protected]>
> Cc: Greg Kroah-Hartman <[email protected]>
> Cc: Tony Nguyen <[email protected]>
> Cc: Vinod Koul <[email protected]>
> Cc: Daniel Borkmann <[email protected]>
> Cc: Mauro Carvalho Chehab <[email protected]>
> Cc: Akira Yokosawa <[email protected]>
> Cc: "Rafael J. Wysocki" <[email protected]>
> Cc: Jens Axboe <[email protected]>
> Cc: [email protected]
> Suggested-by: Akira Yokosawa <[email protected]>
Please don't put this Suggested-by: at the moment.
Thanks, Akira
> Signed-off-by: Bagas Sanjaya <[email protected]>
> ---
> 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
> =============================
>
On 28/03/22 14.46, Akira Yokosawa wrote:
> 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!
>
My intention is to give page title for kernel-doc.rst, according to
documentation guideline at [1].
>>
>> Cc: Jonathan Corbet <[email protected]>
>> Cc: "David S. Miller" <[email protected]>
>> Cc: Greg Kroah-Hartman <[email protected]>
>> Cc: Tony Nguyen <[email protected]>
>> Cc: Vinod Koul <[email protected]>
>> Cc: Daniel Borkmann <[email protected]>
>> Cc: Mauro Carvalho Chehab <[email protected]>
>> Cc: Akira Yokosawa <[email protected]>
>> Cc: "Rafael J. Wysocki" <[email protected]>
>> Cc: Jens Axboe <[email protected]>
>> Cc: [email protected]
>> Suggested-by: Akira Yokosawa <[email protected]>
>
> Please don't put this Suggested-by: at the moment.
>
> Thanks, Akira
>
OK, will drop the trailer.
--
An old man doll... just what I always wanted! - Clara