linux-kernel - Re: [PATCH v2 2/2] Documentation: sphinx: replace "Introduction" chapter heading with 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: Windows password security audit tool. GUI, reports in PDF.

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

Message-ID: <20220326145708.7926b29d@coco.lan>
Date:   Sat, 26 Mar 2022 14:57:21 +0100
From:   Mauro Carvalho Chehab <mchehab@...nel.org>
To:     Bagas Sanjaya <bagasdotme@...il.com>
Cc:     linux-doc@...r.kernel.org, Jonathan Corbet <corbet@....net>,
        "David S. Miller" <davem@...emloft.net>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        "Rafael J. Wysocki" <rafael.j.wysocki@...el.com>,
        Jens Axboe <axboe@...nel.dk>,
        Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
        Akira Yokosawa <akiyks@...il.com>, linux-kernel@...r.kernel.org
Subject: Re: [PATCH v2 2/2] Documentation: sphinx: replace "Introduction"
 chapter heading with page title

Em Sat, 26 Mar 2022 19:33:38 +0700
Bagas Sanjaya <bagasdotme@...il.com> escreveu:

> Replace first chapter heading ("Introduction") with page title named
> "Using Sphinx for kernel documentation". This way, the first-level TOC
> for doc-guide contains title instead of chapter headings for this page.
> 
> Cc: Jonathan Corbet <corbet@....net>
> Cc: "David S. Miller" <davem@...emloft.net>
> Cc: Greg Kroah-Hartman <gregkh@...uxfoundation.org>
> Cc: "Rafael J. Wysocki" <rafael.j.wysocki@...el.com>
> Cc: Jens Axboe <axboe@...nel.dk>
> Cc: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
> Cc: Akira Yokosawa <akiyks@...il.com>
> Cc: linux-kernel@...r.kernel.org
> Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>

Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>

> ---
>  Documentation/doc-guide/sphinx.rst | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst
> index bb36f18ae9ac3e..2ff1ab4158d48e 100644
> --- a/Documentation/doc-guide/sphinx.rst
> +++ b/Documentation/doc-guide/sphinx.rst
> @@ -1,7 +1,8 @@
>  .. _sphinxdoc:
>  
> -Introduction
> -============
> +=====================================
> +Using Sphinx for kernel documentation
> +=====================================
>  
>  The Linux kernel uses `Sphinx`_ to generate pretty documentation from
>  `reStructuredText`_ files under ``Documentation``. To build the documentation in



Thanks,
Mauro