From: "Paul E. McKenney" <paulmck@linux.vnet.ibm.com>
To: linux-kernel@vger.kernel.org, linux-arch@vger.kernel.org,
mingo@kernel.org
Cc: stern@rowland.harvard.edu, parri.andrea@gmail.com,
will.deacon@arm.com, peterz@infradead.org, boqun.feng@gmail.com,
npiggin@gmail.com, dhowells@redhat.com, j.alglave@ucl.ac.uk,
luc.maranget@inria.fr, akiyks@gmail.com,
SeongJae Park <sj38.park@gmail.com>,
"Paul E. McKenney" <paulmck@linux.vnet.ibm.com>
Subject: [PATCH memory-model 8/8] atomic_ops.rst: Use `warning` rst directive
Date: Mon, 14 May 2018 15:55:33 -0700 [thread overview]
Message-ID: <1526338533-6044-8-git-send-email-paulmck@linux.vnet.ibm.com> (raw)
In-Reply-To: <20180514225457.GA5142@linux.vnet.ibm.com>
From: SeongJae Park <sj38.park@gmail.com>
One warning message in 'atomic_ops.rst' is not using 'warning' rst
directive while others does. This commit modifies the message to use
'warning' rst directive.
Signed-off-by: SeongJae Park <sj38.park@gmail.com>
Signed-off-by: Paul E. McKenney <paulmck@linux.vnet.ibm.com>
---
Documentation/core-api/atomic_ops.rst | 10 ++++++----
1 file changed, 6 insertions(+), 4 deletions(-)
diff --git a/Documentation/core-api/atomic_ops.rst b/Documentation/core-api/atomic_ops.rst
index 4ea4af71e68a..2e7165f86f55 100644
--- a/Documentation/core-api/atomic_ops.rst
+++ b/Documentation/core-api/atomic_ops.rst
@@ -466,10 +466,12 @@ Like the above, except that these routines return a boolean which
indicates whether the changed bit was set _BEFORE_ the atomic bit
operation.
-WARNING! It is incredibly important that the value be a boolean,
-ie. "0" or "1". Do not try to be fancy and save a few instructions by
-declaring the above to return "long" and just returning something like
-"old_val & mask" because that will not work.
+
+.. warning::
+ It is incredibly important that the value be a boolean, ie. "0" or "1".
+ Do not try to be fancy and save a few instructions by declaring the
+ above to return "long" and just returning something like "old_val &
+ mask" because that will not work.
For one thing, this return value gets truncated to int in many code
paths using these interfaces, so on 64-bit if the bit is set in the
--
2.5.2
next prev parent reply other threads:[~2018-05-14 22:54 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-05-14 22:54 [PATCH memory-model 0/8] memory-barriers.txt and atomic_ops.rst updates Paul E. McKenney
2018-05-14 22:55 ` [PATCH memory-model 1/8] docs/memory-barriers.txt: Fix broken DMA vs MMIO ordering example Paul E. McKenney
2018-05-15 6:21 ` [tip:locking/core] locking/memory-barriers.txt: Fix broken DMA vs. " tip-bot for Will Deacon
2018-05-14 22:55 ` [PATCH memory-model 2/8] kokr/doc: READ_ONCE() now implies smp_barrier_depends() Paul E. McKenney
2018-05-15 6:22 ` [tip:locking/core] locking/memory-barriers.txt/kokr: Update Korean translation to indicate that " tip-bot for SeongJae Park
2018-05-14 22:55 ` [PATCH memory-model 3/8] kokr/doc: De-emphasize smp_read_barrier_depends Paul E. McKenney
2018-05-15 6:22 ` [tip:locking/core] locking/memory-barriers.txt/kokr: Update Korean translation to de-emphasize smp_read_barrier_depends() tip-bot for SeongJae Park
2018-05-14 22:55 ` [PATCH memory-model 4/8] kokr/Documentation/memory-barriers.txt: Cross-reference "tools/memory-model/" Paul E. McKenney
2018-05-15 6:23 ` [tip:locking/core] locking/memory-barriers.txt/kokr: Update Korean translation to cross-reference "tools/memory-model/" tip-bot for SeongJae Park
2018-05-14 22:55 ` [PATCH memory-model 5/8] kokr/memory-barriers: Fix description of data dependency barriers Paul E. McKenney
2018-05-15 6:23 ` [tip:locking/core] locking/memory-barriers.txt/kokr: Update Korean translation to fix " tip-bot for SeongJae Park
2018-05-14 22:55 ` [PATCH memory-model 6/8] kokr/locking/memory-barriers: De-emphasize smp_read_barrier_depends() some more Paul E. McKenney
2018-05-15 6:24 ` [tip:locking/core] locking/memory-barriers.txt/kokr: Update Korean translation to de-emphasize " tip-bot for SeongJae Park
2018-05-14 22:55 ` [PATCH memory-model 7/8] atomic_ops.rst: Fix wrong example code Paul E. McKenney
2018-05-15 6:24 ` [tip:locking/core] locking/Documentation: Fix incorrect " tip-bot for SeongJae Park
2018-05-14 22:55 ` Paul E. McKenney [this message]
2018-05-15 6:25 ` [tip:locking/core] locking/Documentation: Use `warning` RST directive tip-bot for SeongJae Park
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=1526338533-6044-8-git-send-email-paulmck@linux.vnet.ibm.com \
--to=paulmck@linux.vnet.ibm.com \
--cc=akiyks@gmail.com \
--cc=boqun.feng@gmail.com \
--cc=dhowells@redhat.com \
--cc=j.alglave@ucl.ac.uk \
--cc=linux-arch@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=luc.maranget@inria.fr \
--cc=mingo@kernel.org \
--cc=npiggin@gmail.com \
--cc=parri.andrea@gmail.com \
--cc=peterz@infradead.org \
--cc=sj38.park@gmail.com \
--cc=stern@rowland.harvard.edu \
--cc=will.deacon@arm.com \
/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).