linux-kernel - Re: [PATCH v4 34/52] docs: pstore-blk.rst: fix kernel-doc tags

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]

Message-ID: <202009301623.496E3F85@keescook>
Date:   Wed, 30 Sep 2020 16:23:55 -0700
From:   Kees Cook <keescook@...omium.org>
To:     Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
Cc:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Jonathan Corbet <corbet@....net>,
        Anton Vorontsov <anton@...msg.org>,
        Colin Cross <ccross@...roid.com>,
        Tony Luck <tony.luck@...el.com>, linux-kernel@...r.kernel.org
Subject: Re: [PATCH v4 34/52] docs: pstore-blk.rst: fix kernel-doc tags

On Wed, Sep 30, 2020 at 03:24:57PM +0200, Mauro Carvalho Chehab wrote:
> There is currently a problem with kernel-doc tags from blk.c:
> 
> 	.../Documentation/admin-guide/pstore-blk:239: ./fs/pstore/blk.c:175: WARNING: Duplicate C declaration, also defined in 'admin-guide/pstore-blk'.
> 	Declaration is 'register_pstore_device'.
> 	.../Documentation/admin-guide/pstore-blk:239: ./fs/pstore/blk.c:432: WARNING: Duplicate C declaration, also defined in 'admin-guide/pstore-blk'.
> 	Declaration is 'register_pstore_blk'.
> 	.../Documentation/admin-guide/pstore-blk:242: ./include/linux/pstore_blk.h:43: WARNING: Duplicate C declaration, also defined in 'admin-guide/pstore-blk'.
> 	Declaration is 'pstore_device_info'.
> 
> Basically, the internal parts is shown with :export:, instead
> of :internal:. Yet, there are some other exported docs that
> aren't at the document, because they lack :identifiers:.
> 
> So, instead, let's just use :export: at the kAPI part of
> the documentation.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>

That should work; thanks!

Acked-by: Kees Cook <keescook@...omium.org>

-- 
Kees Cook