linux-kernel.vger.kernel.org archive mirror
 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>,
	"Paul E. McKenney" <paulmck@kernel.org>,
	Josh Triplett <josh@joshtriplett.org>,
	Steven Rostedt <rostedt@goodmis.org>,
	Mathieu Desnoyers <mathieu.desnoyers@efficios.com>,
	Lai Jiangshan <jiangshanlai@gmail.com>,
	Joel Fernandes <joel@joelfernandes.org>,
	rcu@vger.kernel.org
Subject: [PATCH 09/17] rcu: update.c: get rid of some doc warnings
Date: Tue, 17 Mar 2020 15:54:18 +0100	[thread overview]
Message-ID: <c69a85d13717c2aec563f702bffd7cd1e3be6a88.1584456635.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1584456635.git.mchehab+huawei@kernel.org>

We need to escape *ret, as otherwise the documentation system
thinks that this is an incomplete emphasis block:

	./kernel/rcu/update.c:65: WARNING: Inline emphasis start-string without end-string.
	./kernel/rcu/update.c:65: WARNING: Inline emphasis start-string without end-string.
	./kernel/rcu/update.c:70: WARNING: Inline emphasis start-string without end-string.
	./kernel/rcu/update.c:82: WARNING: Inline emphasis start-string without end-string.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 kernel/rcu/update.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/kernel/rcu/update.c b/kernel/rcu/update.c
index b1fa519e5890..16058a5e6da4 100644
--- a/kernel/rcu/update.c
+++ b/kernel/rcu/update.c
@@ -63,12 +63,12 @@ module_param(rcu_normal_after_boot, int, 0);
  * rcu_read_lock_held_common() - might we be in RCU-sched read-side critical section?
  * @ret:	Best guess answer if lockdep cannot be relied on
  *
- * Returns true if lockdep must be ignored, in which case *ret contains
+ * Returns true if lockdep must be ignored, in which case ``*ret`` contains
  * the best guess described below.  Otherwise returns false, in which
- * case *ret tells the caller nothing and the caller should instead
+ * case ``*ret`` tells the caller nothing and the caller should instead
  * consult lockdep.
  *
- * If CONFIG_DEBUG_LOCK_ALLOC is selected, set *ret to nonzero iff in an
+ * If CONFIG_DEBUG_LOCK_ALLOC is selected, set ``*ret`` to nonzero iff in an
  * RCU-sched read-side critical section.  In absence of
  * CONFIG_DEBUG_LOCK_ALLOC, this assumes we are in an RCU-sched read-side
  * critical section unless it can prove otherwise.  Note that disabling
@@ -82,7 +82,7 @@ module_param(rcu_normal_after_boot, int, 0);
  *
  * Note that if the CPU is in the idle loop from an RCU point of view (ie:
  * that we are in the section between rcu_idle_enter() and rcu_idle_exit())
- * then rcu_read_lock_held() sets *ret to false even if the CPU did an
+ * then rcu_read_lock_held() sets ``*ret`` to false even if the CPU did an
  * rcu_read_lock().  The reason for this is that RCU ignores CPUs that are
  * in such a section, considering these as in extended quiescent state,
  * so such a CPU is effectively never in an RCU read-side critical section
-- 
2.24.1


  parent reply	other threads:[~2020-03-17 14:54 UTC|newest]

Thread overview: 41+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <cover.1584456635.git.mchehab+huawei@kernel.org>
2020-03-17 14:54 ` [PATCH 01/17] docs: amu: supress some Sphinx warnings Mauro Carvalho Chehab
2020-03-17 14:54 ` [PATCH 02/17] docs: arm64: booting.rst: get rid of some warnings Mauro Carvalho Chehab
2020-03-17 14:54 ` [PATCH 03/17] docs: pci: boot-interrupts.rst: improve html output Mauro Carvalho Chehab
2020-03-17 22:06   ` Bjorn Helgaas
2020-03-17 14:54 ` [PATCH 04/17] kernel: futex.c: get rid of a docs build warning Mauro Carvalho Chehab
2020-03-17 16:58   ` Peter Zijlstra
2020-03-17 17:36     ` Jonathan Corbet
2020-03-17 19:16       ` Peter Zijlstra
2020-03-20 15:28   ` Thomas Gleixner
2020-03-20 15:43     ` Jonathan Corbet
2020-03-20 16:00     ` Mauro Carvalho Chehab
2020-03-23 16:33       ` Thomas Gleixner
2020-03-17 14:54 ` [PATCH 05/17] devfreq: devfreq.h: get rid of some doc warnings Mauro Carvalho Chehab
2020-03-18  4:08   ` Chanwoo Choi
2020-03-17 14:54 ` [PATCH 06/17] firewire: firewire-cdev.hL get rid of a docs warning Mauro Carvalho Chehab
2020-03-17 17:27   ` Stefan Richter
2020-03-17 14:54 ` [PATCH 07/17] scripts: kernel-doc: proper handle @foo->bar() Mauro Carvalho Chehab
2020-03-17 14:54 ` [PATCH 08/17] lib: bitmap.c: get rid of some doc warnings Mauro Carvalho Chehab
2020-03-17 14:54 ` Mauro Carvalho Chehab [this message]
2020-03-17 16:45   ` [PATCH 09/17] rcu: update.c: " Paul E. McKenney
2020-03-17 14:54 ` [PATCH 10/17] net: phy: sfp-bus.c: get rid of docs warnings Mauro Carvalho Chehab
2020-03-18  6:39   ` David Miller
2020-03-17 14:54 ` [PATCH 11/17] net: core: dev.c: fix a documentation warning Mauro Carvalho Chehab
2020-03-18  6:40   ` David Miller
2020-03-17 14:54 ` [PATCH 12/17] gpio: gpiolib.c: fix a doc warning Mauro Carvalho Chehab
2020-03-18  9:15   ` Bartosz Golaszewski
2020-03-27 10:22   ` Linus Walleij
2020-03-27 13:47     ` Mauro Carvalho Chehab
2020-03-27 19:25   ` Linus Walleij
2020-03-17 14:54 ` [PATCH 13/17] i2c: include/linux/i2c.h: " Mauro Carvalho Chehab
2020-03-17 15:03   ` Wolfram Sang
2020-03-17 15:05     ` Mauro Carvalho Chehab
2020-03-22 16:21   ` Wolfram Sang
2020-03-17 14:54 ` [PATCH 14/17] infiniband: pa_vnic_encap.h: get rid of a warning Mauro Carvalho Chehab
2020-03-19  0:36   ` Jason Gunthorpe
2020-03-27 14:32     ` Mauro Carvalho Chehab
2020-03-27 15:51       ` Jason Gunthorpe
2020-03-17 14:54 ` [PATCH 15/17] ata: libata-core: fix a doc warning Mauro Carvalho Chehab
2020-03-17 14:54 ` [PATCH 16/17] fs: inode.c: get rid of docs warnings Mauro Carvalho Chehab
2020-03-17 14:54 ` [PATCH 17/17] regulator: driver.h: fix regulator_map_* function names Mauro Carvalho Chehab
2020-03-18 21:57   ` Applied "regulator: driver.h: fix regulator_map_* function names" to the regulator tree Mark Brown

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=c69a85d13717c2aec563f702bffd7cd1e3be6a88.1584456635.git.mchehab+huawei@kernel.org \
    --to=mchehab+huawei@kernel.org \
    --cc=corbet@lwn.net \
    --cc=jiangshanlai@gmail.com \
    --cc=joel@joelfernandes.org \
    --cc=josh@joshtriplett.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mathieu.desnoyers@efficios.com \
    --cc=paulmck@kernel.org \
    --cc=rcu@vger.kernel.org \
    --cc=rostedt@goodmis.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).