From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
Marco Elver <elver@google.com>,
Dmitry Vyukov <dvyukov@google.com>,
kasan-dev@googlegroups.com
Subject: [PATCH v2 08/15] kcsan: fix a kernel-doc warning
Date: Tue, 23 Jun 2020 09:09:04 +0200 [thread overview]
Message-ID: <20f7995fab2ba85ce723203e9a7c822a55cca2af.1592895969.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1592895969.git.mchehab+huawei@kernel.org>
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>
---
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
next prev parent reply other threads:[~2020-06-23 7:10 UTC|newest]
Thread overview: 29+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-06-23 7:08 [PATCH v2 00/15] Documentation fixes Mauro Carvalho Chehab
2020-06-23 7:08 ` Mauro Carvalho Chehab
2020-06-23 7:08 ` Mauro Carvalho Chehab
2020-06-23 7:08 ` [PATCH v2 01/15] mm: vmalloc.c: remove a kernel-doc annotation from a removed parameter Mauro Carvalho Chehab
2020-06-23 7:08 ` [PATCH v2 02/15] net: dev: add a missing kernel-doc annotation Mauro Carvalho Chehab
2020-06-23 7:08 ` [PATCH v2 03/15] net: netdevice.h: add a description for napi_defer_hard_irqs Mauro Carvalho Chehab
2020-06-23 7:09 ` [PATCH v2 04/15] scripts/kernel-doc: parse __ETHTOOL_DECLARE_LINK_MODE_MASK Mauro Carvalho Chehab
2020-06-23 7:09 ` [PATCH v2 05/15] net: pylink.h: add kernel-doc descriptions for new fields at phylink_config Mauro Carvalho Chehab
2020-06-23 9:07 ` Russell King - ARM Linux admin
2020-06-23 7:09 ` [PATCH v2 06/15] scripts/kernel-doc: handle function pointer prototypes Mauro Carvalho Chehab
2020-06-23 7:09 ` [PATCH v2 07/15] fs: fs.h: fix a kernel-doc parameter description Mauro Carvalho Chehab
2020-06-23 7:09 ` Mauro Carvalho Chehab [this message]
2020-06-23 7:09 ` [PATCH v2 09/15] selftests/vm/keys: fix a broken reference at protection_keys.c Mauro Carvalho Chehab
2020-06-23 7:09 ` [PATCH v2 10/15] docs: hugetlbpage.rst: fix some warnings Mauro Carvalho Chehab
2020-06-23 17:38 ` Mike Kravetz
2020-06-23 7:09 ` [PATCH v2 11/15] docs: powerpc: fix some issues at vas-api.rst Mauro Carvalho Chehab
2020-06-23 7:09 ` Mauro Carvalho Chehab
2020-06-23 7:09 ` [PATCH v2 12/15] docs: driver-model: remove a duplicated markup at driver.rst Mauro Carvalho Chehab
2020-06-23 7:09 ` [PATCH v2 13/15] docs: ABI: fix a typo when pointing to w1-generic.rst Mauro Carvalho Chehab
2020-06-23 7:09 ` [PATCH v2 14/15] docs: fix references for DMA*.txt files Mauro Carvalho Chehab
2020-06-23 7:09 ` Mauro Carvalho Chehab
2020-06-23 7:09 ` Mauro Carvalho Chehab
2020-06-23 7:22 ` Christoph Hellwig
2020-06-23 7:22 ` Christoph Hellwig
2020-06-23 7:22 ` Christoph Hellwig
2020-06-23 7:09 ` [PATCH v2 15/15] docs: fs: proc.rst: convert a new chapter to ReST Mauro Carvalho Chehab
2020-06-26 16:13 ` [PATCH v2 00/15] Documentation fixes Jonathan Corbet
2020-06-26 16:13 ` Jonathan Corbet
2020-06-26 16:13 ` Jonathan Corbet
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20f7995fab2ba85ce723203e9a7c822a55cca2af.1592895969.git.mchehab+huawei@kernel.org \
--to=mchehab+huawei@kernel.org \
--cc=corbet@lwn.net \
--cc=dvyukov@google.com \
--cc=elver@google.com \
--cc=kasan-dev@googlegroups.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.