tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

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>

authored by

Mauro Carvalho Chehab and committed by
Jonathan Corbet 15d737f8 21b9cb34

+6 -4
+6 -4
include/linux/kcsan-checks.h
··· 337 337 * release_for_reuse(obj); 338 338 * } 339 339 * 340 - * Note: ASSERT_EXCLUSIVE_ACCESS_SCOPED(), if applicable, performs more thorough 341 - * checking if a clear scope where no concurrent accesses are expected exists. 340 + * Note: 342 341 * 343 - * Note: For cases where the object is freed, `KASAN <kasan.html>`_ is a better 344 - * fit to detect use-after-free bugs. 342 + * 1. ASSERT_EXCLUSIVE_ACCESS_SCOPED(), if applicable, performs more thorough 343 + * checking if a clear scope where no concurrent accesses are expected exists. 344 + * 345 + * 2. For cases where the object is freed, `KASAN <kasan.html>`_ is a better 346 + * fit to detect use-after-free bugs. 345 347 * 346 348 * @var: variable to assert on 347 349 */