diff options
| author | Mauro Carvalho Chehab <mchehab+huawei@kernel.org> | 2020-06-23 10:09:04 +0300 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2020-06-26 19:01:08 +0300 |
| commit | 15d737f8a14e73fcf25f6f797630279a203ce99c (patch) | |
| tree | bb05e2be54a1b4755f8a9f7a636d41c933fbafd6 /include/linux/kcsan-checks.h | |
| parent | 21b9cb34385d93d661a9134adf19eae2bd734218 (diff) | |
| download | linux-15d737f8a14e73fcf25f6f797630279a203ce99c.tar.xz | |
kcsan: fix a kernel-doc warning
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@kernel.org>
Acked-by: Marco Elver <elver@google.com>
Link: https://lore.kernel.org/r/20f7995fab2ba85ce723203e9a7c822a55cca2af.1592895969.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'include/linux/kcsan-checks.h')
| -rw-r--r-- | include/linux/kcsan-checks.h | 10 |
1 files 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 */ |