On Mon, 15 Jun 2020 at 08:47, Mauro Carvalho Chehab <[email protected]> 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 <[email protected]>
Acked-by: Marco Elver <[email protected]> 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 >
