All of lore.kernel.org
 help / color / mirror / Atom feed
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 09/29] kcsan: fix a kernel-doc warning
Date: Mon, 15 Jun 2020 08:46:48 +0200	[thread overview]
Message-ID: <019097f1fe10e38a04b662f1d002ecc0ce8bef8a.1592203542.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1592203542.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>
---
 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


  parent reply	other threads:[~2020-06-15  6:49 UTC|newest]

Thread overview: 107+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-06-15  6:46 [PATCH 00/29] Documentation fixes Mauro Carvalho Chehab
2020-06-15  6:46 ` Mauro Carvalho Chehab
2020-06-15  6:46 ` Mauro Carvalho Chehab
2020-06-15  6:46 ` Mauro Carvalho Chehab
2020-06-15  6:46 ` Mauro Carvalho Chehab
2020-06-15  6:46 ` [f2fs-dev] " Mauro Carvalho Chehab
2020-06-15  6:46 ` [PATCH 01/29] mm: vmalloc.c: remove a kernel-doc annotation from a removed parameter Mauro Carvalho Chehab
2020-06-15  6:46 ` [PATCH 02/29] net: dev: add a missing kernel-doc annotation Mauro Carvalho Chehab
2020-06-15  6:46 ` [PATCH 03/29] net: netdevice.h: add a description for napi_defer_hard_irqs Mauro Carvalho Chehab
2020-06-15  6:46 ` [PATCH 04/29] scripts/kernel-doc: parse __ETHTOOL_DECLARE_LINK_MODE_MASK Mauro Carvalho Chehab
2020-06-15  6:46 ` [PATCH 05/29] net: pylink.h: add kernel-doc descriptions for new fields at phylink_config Mauro Carvalho Chehab
2020-06-15  6:46 ` [PATCH 06/29] scripts/kernel-doc: handle function pointer prototypes Mauro Carvalho Chehab
2020-06-15  6:46 ` [PATCH 07/29] fs: fs.h: fix a kernel-doc parameter description Mauro Carvalho Chehab
2020-06-15  8:47   ` Jan Kara
2020-06-15  6:46 ` [PATCH 08/29] gpio: driver.h: fix kernel-doc markup Mauro Carvalho Chehab
2020-06-15  8:05   ` Bartosz Golaszewski
2020-06-15  6:46 ` Mauro Carvalho Chehab [this message]
2020-06-15  6:56   ` [PATCH 09/29] kcsan: fix a kernel-doc warning Marco Elver
2020-06-15  6:46 ` [PATCH 10/29] rcu: fix some kernel-doc warnings Mauro Carvalho Chehab
2020-06-15 20:36   ` Paul E. McKenney
2020-06-15  6:46 ` [PATCH 11/29] fs: docs: f2fs.rst: fix a broken table Mauro Carvalho Chehab
2020-06-15  6:46   ` [f2fs-dev] " Mauro Carvalho Chehab
2020-06-15  6:46 ` [PATCH 12/29] dt: update a reference for reneases pcar file renamed to yaml Mauro Carvalho Chehab
2020-06-15  7:38   ` Geert Uytterhoeven
2020-06-18 16:41   ` Rob Herring
2020-06-15  6:46 ` [PATCH 13/29] dt: fix broken links due to txt->yaml renames Mauro Carvalho Chehab
2020-06-15  6:46   ` Mauro Carvalho Chehab
2020-06-15  6:46   ` Mauro Carvalho Chehab
2020-06-15  6:46   ` Mauro Carvalho Chehab
2020-06-15  6:46   ` Mauro Carvalho Chehab
2020-06-15  6:46   ` Mauro Carvalho Chehab
2020-06-15  8:13   ` Thomas Bogendoerfer
2020-06-15  8:13     ` Thomas Bogendoerfer
2020-06-15  8:13     ` Thomas Bogendoerfer
2020-06-15  8:13     ` Thomas Bogendoerfer
2020-06-15  8:13     ` Thomas Bogendoerfer
2020-06-15  8:13     ` Thomas Bogendoerfer
2020-06-15 11:19   ` Mark Brown
2020-06-15 11:19     ` Mark Brown
2020-06-15 11:19     ` Mark Brown
2020-06-15 11:19     ` Mark Brown
2020-06-15 11:19     ` Mark Brown
2020-06-15 11:19     ` Mark Brown
2020-06-15 11:57     ` Mauro Carvalho Chehab
2020-06-15 11:57       ` Mauro Carvalho Chehab
2020-06-15 11:57       ` Mauro Carvalho Chehab
2020-06-15 11:57       ` Mauro Carvalho Chehab
2020-06-15 11:57       ` Mauro Carvalho Chehab
2020-06-15 11:57       ` Mauro Carvalho Chehab
2020-06-15 12:01       ` Mark Brown
2020-06-15 12:01         ` Mark Brown
2020-06-15 12:01         ` Mark Brown
2020-06-15 12:01         ` Mark Brown
2020-06-15 12:01         ` Mark Brown
2020-06-15 12:01         ` Mark Brown
2020-06-18 16:44   ` Rob Herring
2020-06-18 16:44     ` Rob Herring
2020-06-18 16:44     ` Rob Herring
2020-06-18 16:44     ` Rob Herring
2020-06-18 16:44     ` Rob Herring
2020-06-18 16:44     ` Rob Herring
2020-06-15  6:46 ` [PATCH 14/29] dt: Fix broken references to renamed docs Mauro Carvalho Chehab
2020-06-15  6:46   ` Mauro Carvalho Chehab
2020-06-15  6:46   ` Mauro Carvalho Chehab
2020-06-15  7:48   ` Philipp Zabel
2020-06-15  7:48     ` Philipp Zabel
2020-06-15  7:48     ` Philipp Zabel
2020-06-15 11:18   ` Mark Brown
2020-06-15 11:18     ` Mark Brown
2020-06-15 11:18     ` Mark Brown
2020-06-18 17:06   ` Rob Herring
2020-06-18 17:06     ` Rob Herring
2020-06-18 17:06     ` Rob Herring
2020-06-15  6:46 ` [PATCH 15/29] dt: fix reference to olpc,xo1.75-ec.txt Mauro Carvalho Chehab
2020-06-16  8:20   ` Lubomir Rintel
2020-06-18 17:19   ` Rob Herring
2020-06-15  6:46 ` [PATCH 16/29] selftests/vm/keys: fix a broken reference at protection_keys.c Mauro Carvalho Chehab
2020-06-15  6:46 ` [PATCH 17/29] docs: hugetlbpage.rst: fix some warnings Mauro Carvalho Chehab
2020-06-15 11:52   ` Matthew Wilcox
2020-06-15  6:46 ` [PATCH 18/29] docs: powerpc: fix some issues at vas-api.rst Mauro Carvalho Chehab
2020-06-15  6:46   ` Mauro Carvalho Chehab
2020-06-15  6:46 ` [PATCH 19/29] docs: driver-model: remove a duplicated markup at driver.rst Mauro Carvalho Chehab
2020-06-15  6:46 ` [PATCH 20/29] docs: watch_queue.rst: supress some Sphinx warnings and move to core-api Mauro Carvalho Chehab
2020-06-15  6:46   ` Mauro Carvalho Chehab
2020-06-15  6:47 ` [PATCH 21/29] docs: device-mapper: add dm-ebs.rst to an index file Mauro Carvalho Chehab
2020-06-19 16:18   ` Mike Snitzer
2020-06-19 16:18     ` Mike Snitzer
2020-06-15  6:47 ` [PATCH 22/29] docs: it_IT: add two missing references Mauro Carvalho Chehab
2020-06-15  7:39   ` Federico Vaga
2020-06-15  6:47 ` [PATCH 23/29] docs: ABI: fix a typo when pointing to w1-generic.rst Mauro Carvalho Chehab
2020-06-15  6:47 ` [PATCH 24/29] docs: fs: locking.rst: fix a broken table Mauro Carvalho Chehab
2020-06-15  6:47 ` [PATCH 25/29] docs: add bus-virt-phys-mapping.txt to core-api Mauro Carvalho Chehab
2020-06-15  6:47 ` [PATCH 26/29] docs: fix references for DMA*.txt files Mauro Carvalho Chehab
2020-06-15  6:47   ` Mauro Carvalho Chehab
2020-06-15  6:47   ` Mauro Carvalho Chehab
2020-06-15  6:47   ` Mauro Carvalho Chehab
2020-06-15 20:37   ` Paul E. McKenney
2020-06-15 20:37     ` Paul E. McKenney
2020-06-15 20:37     ` Paul E. McKenney
2020-06-15 20:37     ` Paul E. McKenney
2020-06-15  6:47 ` [PATCH 27/29] docs: dt: minor adjustments at writing-schema.rst Mauro Carvalho Chehab
2020-06-18 17:20   ` Rob Herring
2020-06-15  6:47 ` [PATCH 28/29] docs: fs: proc.rst: fix a warning due to a merge conflict Mauro Carvalho Chehab
2020-06-15 11:17   ` Mark Brown
2020-06-15 18:24   ` Kees Cook
2020-06-15  6:47 ` [PATCH 29/29] docs: fs: proc.rst: convert a new chapter to ReST Mauro Carvalho Chehab
2020-06-15 18:24   ` Kees Cook

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=019097f1fe10e38a04b662f1d002ecc0ce8bef8a.1592203542.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.