lkml.org 
[lkml]   [2022]   [Apr]   [5]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
From
SubjectRe: [PATCH v4 0/2] Documentation: doc-guide: Add missing page titles
Date
Bagas Sanjaya <bagasdotme@gmail.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

\
 
 \ /
  Last update: 2022-04-06 01:42    [W:0.052 / U:0.820 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site