From: "Jonathan Neuschäfer" <j.neuschaefer@gmx.net>
To: linux-doc@vger.kernel.org
Cc: "Alan Stern" <stern@rowland.harvard.edu>,
"Andrea Parri" <parri.andrea@gmail.com>,
"Will Deacon" <will@kernel.org>,
"Peter Zijlstra" <peterz@infradead.org>,
"Boqun Feng" <boqun.feng@gmail.com>,
"Nicholas Piggin" <npiggin@gmail.com>,
"David Howells" <dhowells@redhat.com>,
"Jade Alglave" <j.alglave@ucl.ac.uk>,
"Luc Maranget" <luc.maranget@inria.fr>,
"Paul E. McKenney" <paulmck@kernel.org>,
"Akira Yokosawa" <akiyks@gmail.com>,
"Daniel Lustig" <dlustig@nvidia.com>,
"Jonathan Corbet" <corbet@lwn.net>,
linux-kernel@vger.kernel.org, linux-arch@vger.kernel.org,
"Jonathan Neuschäfer" <j.neuschaefer@gmx.net>
Subject: [PATCH 1/3] docs: atomic_ops: Remove colons where they don't make sense
Date: Sun, 8 Mar 2020 20:56:16 +0100 [thread overview]
Message-ID: <20200308195618.22768-2-j.neuschaefer@gmx.net> (raw)
In-Reply-To: <20200308195618.22768-1-j.neuschaefer@gmx.net>
There are a few cases on atomic_ops.rst, where a end-of-line colon
before a code block seems semantically wrong, because the code block is
not related to the sentence before it.
End those lines with `. ::` instead, which is rendered as a period but
still formats the next line/block as a code block.
Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
---
Documentation/core-api/atomic_ops.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/Documentation/core-api/atomic_ops.rst b/Documentation/core-api/atomic_ops.rst
index 724583453e1f..650b9693469a 100644
--- a/Documentation/core-api/atomic_ops.rst
+++ b/Documentation/core-api/atomic_ops.rst
@@ -242,13 +242,13 @@ given atomic counter. They return a boolean indicating whether the
resulting counter value was zero or not.
Again, these primitives provide explicit memory barrier semantics around
-the atomic operation::
+the atomic operation. ::
int atomic_sub_and_test(int i, atomic_t *v);
This is identical to atomic_dec_and_test() except that an explicit
decrement is given instead of the implicit "1". This primitive must
-provide explicit memory barrier semantics around the operation::
+provide explicit memory barrier semantics around the operation. ::
int atomic_add_negative(int i, atomic_t *v);
--
2.20.1
next prev parent reply other threads:[~2020-03-08 19:57 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-03-08 19:56 [PATCH 0/3] docs: a few improvements for atomic_ops.rst Jonathan Neuschäfer
2020-03-08 19:56 ` Jonathan Neuschäfer [this message]
2020-03-08 19:56 ` [PATCH 2/3] docs: atomic_ops: Move two paragraphs into the warning block above Jonathan Neuschäfer
2020-03-08 20:00 ` [PATCH 3/3] docs: atomic_ops: Steer readers towards using refcount_t for reference counts Jonathan Neuschäfer
2020-03-08 21:07 ` Randy Dunlap
2020-03-08 21:25 ` Jonathan Neuschäfer
2020-03-09 9:06 ` [PATCH 0/3] docs: a few improvements for atomic_ops.rst Peter Zijlstra
2020-03-16 15:48 ` Will Deacon
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=20200308195618.22768-2-j.neuschaefer@gmx.net \
--to=j.neuschaefer@gmx.net \
--cc=akiyks@gmail.com \
--cc=boqun.feng@gmail.com \
--cc=corbet@lwn.net \
--cc=dhowells@redhat.com \
--cc=dlustig@nvidia.com \
--cc=j.alglave@ucl.ac.uk \
--cc=linux-arch@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=luc.maranget@inria.fr \
--cc=npiggin@gmail.com \
--cc=parri.andrea@gmail.com \
--cc=paulmck@kernel.org \
--cc=peterz@infradead.org \
--cc=stern@rowland.harvard.edu \
--cc=will@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 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).