lkmm.lists.linux.dev archive mirror
 help / color / mirror / Atom feed
From: Akira Yokosawa <akiyks@gmail.com>
To: "Paul E. McKenney" <paulmck@kernel.org>, lkmm@lists.linux.dev
Cc: "Akira Yokosawa" <akiyks@gmail.com>,
	"Håkon Bugge" <haakon.bugge@oracle.com>
Subject: [PATCH] memory-barriers.txt: Sort wait_event* and wait_on_bit* list alphabetically
Date: Wed, 5 Nov 2025 12:17:28 +0900	[thread overview]
Message-ID: <d06d8be2-5661-4926-8734-d12c30c9e03c@gmail.com> (raw)

Commit 88172700423c ("docs/memory-barriers.txt: Add wait_event_cmd()
and wait_event_exclusive_cmd()") added two APIs without taking care
of the list order.  Sort the list for readability.

While there, make it clear that this is incomplete by saying
"for example".

Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
---
Hi Paul,

Looks like there is no pending change for v6.19 in LKMM.

I think this minor tweak is worth having, if it is not too late.

        Thanks, Akira
--
 Documentation/memory-barriers.txt | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/memory-barriers.txt b/Documentation/memory-barriers.txt
index 1d164e005776..61b7317bcf2e 100644
--- a/Documentation/memory-barriers.txt
+++ b/Documentation/memory-barriers.txt
@@ -2182,9 +2182,11 @@ set_current_state() may be wrapped by:
 
 which therefore also imply a general memory barrier after setting the state.
 The whole sequence above is available in various canned forms, all of which
-interpolate the memory barrier in the right place:
+interpolate the memory barrier in the right place, for example:
 
 	wait_event();
+	wait_event_cmd();
+	wait_event_exclusive_cmd();
 	wait_event_interruptible();
 	wait_event_interruptible_exclusive();
 	wait_event_interruptible_timeout();
@@ -2192,8 +2194,6 @@ interpolate the memory barrier in the right place:
 	wait_event_timeout();
 	wait_on_bit();
 	wait_on_bit_lock();
-	wait_event_cmd();
-	wait_event_exclusive_cmd();
 
 
 Secondly, code that performs a wake up normally follows something like this:

base-commit: 4356abc63687c65a86ab709db96470540441e822
-- 
2.43.0


             reply	other threads:[~2025-11-05  3:17 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-11-05  3:17 Akira Yokosawa [this message]
2025-11-05  8:48 ` [PATCH] memory-barriers.txt: Sort wait_event* and wait_on_bit* list alphabetically Haakon Bugge
2025-11-05 18:19   ` 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=d06d8be2-5661-4926-8734-d12c30c9e03c@gmail.com \
    --to=akiyks@gmail.com \
    --cc=haakon.bugge@oracle.com \
    --cc=lkmm@lists.linux.dev \
    --cc=paulmck@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 read-only IMAP folder(s) and NNTP newsgroup(s).