linux-kernel - Re: [PATCH 09/29] kcsan: fix a kernel-doc warning

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: <CANpmjNOG2PmMoCQgNk3cJrm+ZFP0+VYpBWma=xRfqoyxbLZp9A@mail.gmail.com>
Date:   Mon, 15 Jun 2020 08:56:05 +0200
From:   Marco Elver <elver@...gle.com>
To:     Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
Cc:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        LKML <linux-kernel@...r.kernel.org>,
        Jonathan Corbet <corbet@....net>,
        Dmitry Vyukov <dvyukov@...gle.com>,
        kasan-dev <kasan-dev@...glegroups.com>
Subject: Re: [PATCH 09/29] kcsan: fix a kernel-doc warning

On Mon, 15 Jun 2020 at 08:47, Mauro Carvalho Chehab
<mchehab+huawei@...nel.org> wrote:
>
> One of the kernel-doc markups there have two "note" sections:
>
>         ./include/linux/kcsan-checks.h:346: warning: duplicate section name 'Note'
>
> While this is not the case here, duplicated sections can cause
> build issues on Sphinx. So, let's change the notes section
> to use, instead, a list for those 2 notes at the same function.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>

Acked-by: Marco Elver <elver@...gle.com>

Thanks!

> ---
>  include/linux/kcsan-checks.h | 10 ++++++----
>  1 file changed, 6 insertions(+), 4 deletions(-)
>
> diff --git a/include/linux/kcsan-checks.h b/include/linux/kcsan-checks.h
> index 7b0b9c44f5f3..c5f6c1dcf7e3 100644
> --- a/include/linux/kcsan-checks.h
> +++ b/include/linux/kcsan-checks.h
> @@ -337,11 +337,13 @@ static inline void __kcsan_disable_current(void) { }
>   *             release_for_reuse(obj);
>   *     }
>   *
> - * Note: ASSERT_EXCLUSIVE_ACCESS_SCOPED(), if applicable, performs more thorough
> - * checking if a clear scope where no concurrent accesses are expected exists.
> + * Note:
>   *
> - * Note: For cases where the object is freed, `KASAN <kasan.html>`_ is a better
> - * fit to detect use-after-free bugs.
> + * 1. ASSERT_EXCLUSIVE_ACCESS_SCOPED(), if applicable, performs more thorough
> + *    checking if a clear scope where no concurrent accesses are expected exists.
> + *
> + * 2. For cases where the object is freed, `KASAN <kasan.html>`_ is a better
> + *    fit to detect use-after-free bugs.
>   *
>   * @var: variable to assert on
>   */
> --
> 2.26.2
>