mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: "Paul E. McKenney" <paulmck@linux.vnet.ibm.com>
To: linux-kernel@vger.kernel.org
Cc: mingo@kernel.org, jiangshanlai@gmail.com, dipankar@in.ibm.com,
	akpm@linux-foundation.org, mathieu.desnoyers@efficios.com,
	josh@joshtriplett.org, tglx@linutronix.de, peterz@infradead.org,
	rostedt@goodmis.org, dhowells@redhat.com, edumazet@google.com,
	fweisbec@gmail.com, oleg@redhat.com,
	"Paul E. McKenney" <paulmck@linux.vnet.ibm.com>
Subject: [PATCH tip/core/rcu 11/16] doc: Fix list and emphasis in rcupdate.h
Date: Wed,  4 Oct 2017 14:21:21 -0700	[thread overview]
Message-ID: <1507152086-9791-11-git-send-email-paulmck@linux.vnet.ibm.com> (raw)
In-Reply-To: <20171004212051.GA8411@linux.vnet.ibm.com>

Signed-off-by: Paul E. McKenney <paulmck@linux.vnet.ibm.com>
---
 include/linux/rcupdate.h | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)

diff --git a/include/linux/rcupdate.h b/include/linux/rcupdate.h
index 77f2e136bf81..1fd71d7458aa 100644
--- a/include/linux/rcupdate.h
+++ b/include/linux/rcupdate.h
@@ -523,7 +523,7 @@ static inline void rcu_preempt_sleep_check(void) { }
  * Return the value of the specified RCU-protected pointer, but omit
  * both the smp_read_barrier_depends() and the READ_ONCE().  This
  * is useful in cases where update-side locks prevent the value of the
- * pointer from changing.  Please note that this primitive does -not-
+ * pointer from changing.  Please note that this primitive does *not*
  * prevent the compiler from repeating this reference or combining it
  * with other references, so it should not be used without protection
  * of appropriate locks.
@@ -785,13 +785,14 @@ static inline notrace void rcu_read_unlock_sched_notrace(void)
  * do not need ordering constraints on the CPU or the compiler.  These
  * special cases are:
  *
- * 1.	This use of RCU_INIT_POINTER() is NULLing out the pointer -or-
+ * 1.	This use of RCU_INIT_POINTER() is NULLing out the pointer *or*
  * 2.	The caller has taken whatever steps are required to prevent
- *	RCU readers from concurrently accessing this pointer -or-
+ *	RCU readers from concurrently accessing this pointer *or*
  * 3.	The referenced data structure has already been exposed to
- *	readers either at compile time or via rcu_assign_pointer() -and-
- *	a.	You have not made -any- reader-visible changes to
- *		this structure since then -or-
+ *	readers either at compile time or via rcu_assign_pointer() *and*
+ *
+ *	a.	You have not made *any* reader-visible changes to
+ *		this structure since then *or*
  *	b.	It is OK for readers accessing this structure from its
  *		new location to see the old state of the structure.  (For
  *		example, the changes were to statistical counters or to
@@ -807,7 +808,7 @@ static inline notrace void rcu_read_unlock_sched_notrace(void)
  * by a single external-to-structure RCU-protected pointer, then you may
  * use RCU_INIT_POINTER() to initialize the internal RCU-protected
  * pointers, but you must use rcu_assign_pointer() to initialize the
- * external-to-structure pointer -after- you have completely initialized
+ * external-to-structure pointer *after* you have completely initialized
  * the reader-accessible portions of the linked structure.
  *
  * Note that unlike rcu_assign_pointer(), RCU_INIT_POINTER() provides no
-- 
2.5.2

  parent reply	other threads:[~2017-10-04 21:22 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-10-04 21:20 [PATCH tip/core/rcu 0/16] Documentation updates for v4.15 Paul E. McKenney
2017-10-04 21:21 ` [PATCH tip/core/rcu 01/16] documentation: RCU grace-period memory ordering guarantees Paul E. McKenney
2017-10-04 21:21 ` [PATCH tip/core/rcu 02/16] documentation: Long-running irq handlers can stall RCU grace periods Paul E. McKenney
2017-10-04 21:21 ` [PATCH tip/core/rcu 03/16] documentation: Slow systems " Paul E. McKenney
2017-10-04 21:21 ` [PATCH tip/core/rcu 04/16] documentation: Update RCU CPU stall warning messages Paul E. McKenney
2017-10-04 21:21 ` [PATCH tip/core/rcu 05/16] memory-barriers: Replace uses of "transitive" Paul E. McKenney
2017-10-04 21:21 ` [PATCH tip/core/rcu 06/16] memory-barriers: Rework multicopy-atomicity section Paul E. McKenney
2017-10-04 21:21 ` [PATCH tip/core/rcu 07/16] doc: Fix options for RCU options Paul E. McKenney
2017-10-04 21:21 ` [PATCH tip/core/rcu 08/16] doc: Add parameters to rcupdate.h docbook comments Paul E. McKenney
2017-10-04 21:21 ` [PATCH tip/core/rcu 09/16] rcu: Remove extra docbook comment in rculist.h Paul E. McKenney
2017-10-04 21:21 ` [PATCH tip/core/rcu 10/16] rcu: Fix docbook comments for rcu_sync functions Paul E. McKenney
2017-10-04 21:21 ` Paul E. McKenney [this message]
2017-10-04 21:21 ` [PATCH tip/core/rcu 12/16] doc: Flag code segment in rcu_pointer_handoff()'s docbook header Paul E. McKenney
2017-10-04 21:21 ` [PATCH tip/core/rcu 13/16] doc: Fix code display in rcu_pointer_handoff()'s docbook comment Paul E. McKenney
2017-10-04 21:21 ` [PATCH tip/core/rcu 14/16] doc: Fix tree.c bulleted lists in docbook comment headers Paul E. McKenney
2017-10-04 21:21 ` [PATCH tip/core/rcu 15/16] memory-barriers.txt: Fix typo in pairing example Paul E. McKenney
2017-10-04 21:21 ` [PATCH tip/core/rcu 16/16] Documentation: rewrite confusing statement about memory barriers Paul E. McKenney

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=1507152086-9791-11-git-send-email-paulmck@linux.vnet.ibm.com \
    --to=paulmck@linux.vnet.ibm.com \
    --cc=akpm@linux-foundation.org \
    --cc=dhowells@redhat.com \
    --cc=dipankar@in.ibm.com \
    --cc=edumazet@google.com \
    --cc=fweisbec@gmail.com \
    --cc=jiangshanlai@gmail.com \
    --cc=josh@joshtriplett.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mathieu.desnoyers@efficios.com \
    --cc=mingo@kernel.org \
    --cc=oleg@redhat.com \
    --cc=peterz@infradead.org \
    --cc=rostedt@goodmis.org \
    --cc=tglx@linutronix.de \
    /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

all inboxes | Powered by JetHome®