linux-kernel - Re: [PATCH v4 22/52] docs: get rid of :c:type explicit declarations for structs

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] [thread-next>] [day] [month] [year] [list]

Date:   Wed, 30 Sep 2020 17:26:24 +0300
From:   Mike Rapoport <rppt@...nel.org>
To:     Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
Cc:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Jonathan Corbet <corbet@....net>,
        "Alexander A. Klimov" <grandmaster@...klimov.de>,
        André Almeida <andrealmeid@...labora.com>,
        "Theodore Y. Ts'o" <tytso@....edu>,
        Alexandru Ardelean <alexandru.ardelean@...log.com>,
        Andrew Morton <akpm@...ux-foundation.org>,
        Anshuman Khandual <anshuman.khandual@....com>,
        Eric Biggers <ebiggers@...nel.org>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        Jaegeuk Kim <jaegeuk@...nel.org>,
        Jaroslav Kysela <perex@...ex.cz>, Jens Axboe <axboe@...nel.dk>,
        Jonathan Cameron <Jonathan.Cameron@...wei.com>,
        Mauro Carvalho Chehab <mchehab@...nel.org>,
        Moritz Fischer <mdf@...nel.org>,
        Puranjay Mohan <puranjay12@...il.com>,
        Randy Dunlap <rdunlap@...radead.org>,
        Satya Tangirala <satyat@...gle.com>,
        Takashi Iwai <tiwai@...e.com>, Tom Rix <trix@...hat.com>,
        alsa-devel@...a-project.org, linux-fpga@...r.kernel.org,
        linux-fscrypt@...r.kernel.org, linux-kernel@...r.kernel.org,
        linux-media@...r.kernel.org, linux-mm@...ck.org
Subject: Re: [PATCH v4 22/52] docs: get rid of :c:type explicit declarations
 for structs

On Wed, Sep 30, 2020 at 03:24:45PM +0200, Mauro Carvalho Chehab wrote:
> The :c:type:`foo` only works properly with structs before
> Sphinx 3.x.
> 
> On Sphinx 3.x, structs should now be declared using the
> .. c:struct, and referenced via :c:struct tag.
> 
> As we now have the automarkup.py macro, that automatically
> convert:
> 	struct foo
> 
> into cross-references, let's get rid of that, solving
> several warnings when building docs with Sphinx 3.x.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
> ---
...
>  Documentation/vm/ksm.rst                      |  2 +-
>  Documentation/vm/memory-model.rst             |  6 ++---
>  mm/ksm.c                                      |  2 +-
>  mm/memblock.c                                 |  4 ++--

Reviewed-by: Mike Rapoport <rppt@...ux.ibm.com>

>  30 files changed, 93 insertions(+), 93 deletions(-)
>