Re: [PATCH] memory-barriers.txt: Sort wait_event* and wait_on_bit* list alphabetically

"Paul E. McKenney" <[email protected]> Wed, 5 Nov 2025 10:19:58 -0800
Newsgroups dev.linux.lists.lkmm
Message-ID <f7314b55-a38f-42ba-865c-4a73c52bcea5@paulmck-laptop>
On Wed, Nov 05, 2025 at 08:48:05AM +0000, Haakon Bugge wrote:
> Hi Akira-san,
> 
> > On 5 Nov 2025, at 04:17, Akira Yokosawa <[email protected]> wrote:
> > 
> > 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 <[email protected]>
> 
> LGTM, so:
> 
> Reviewed-by: Håkon Bugge <[email protected]>

Queued, maybe even for the upcoming merge window, thank you both!

						Thanx, Paul

> Thxs, Håkon
> 
> 
> > ---
> > 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
> > 
>