Commit 15d737f8 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet
Browse files

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: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Acked-by: default avatarMarco Elver <elver@google.com>
Link: https://lore.kernel.org/r/20f7995fab2ba85ce723203e9a7c822a55cca2af.1592895969.git.mchehab+huawei@kernel.org


Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 21b9cb34

include/linux/kcsan-checks.h

+6 −4
Original line number Diff line number Diff line
@@ -337,10 +337,12 @@ static inline void __kcsan_disable_current(void) { } 
 *		release_for_reuse(obj);

 *	}

 *

 * Note: ASSERT_EXCLUSIVE_ACCESS_SCOPED(), if applicable, performs more thorough

 * Note:

 *

 * 1. ASSERT_EXCLUSIVE_ACCESS_SCOPED(), if applicable, performs more thorough

 *    checking if a clear scope where no concurrent accesses are expected exists.

 *

 * Note: For cases where the object is freed, `KASAN <kasan.html>`_ is a better

 * 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