Gh0st
/
linux
mirror of https://github.com/torvalds/linux.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

memory-barriers.txt: Sort wait_event* and wait_on_bit* list alphabetically 

Commit 8817270042 ("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>
Reviewed-by: Håkon Bugge <haakon.bugge@oracle.com>
Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
This commit is contained in:
Akira Yokosawa 2025-11-05 12:17:28 +09:00 committed by Paul E. McKenney
parent 3a86608788
commit 7f8fcc6f09
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Documentation/memory-barriers.txt
View File

@ -2182,9 +2182,11 @@ set_current_state() may be wrapped by:
which therefore also imply a general memory barrier after setting the state. 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 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();
wait_event_cmd();
wait_event_exclusive_cmd();
wait_event_interruptible(); wait_event_interruptible();
wait_event_interruptible_exclusive(); wait_event_interruptible_exclusive();
wait_event_interruptible_timeout(); wait_event_interruptible_timeout();
@ -2192,8 +2194,6 @@ interpolate the memory barrier in the right place:
wait_event_timeout(); wait_event_timeout();
wait_on_bit(); wait_on_bit();
wait_on_bit_lock(); wait_on_bit_lock();
wait_event_cmd();
wait_event_exclusive_cmd();
Secondly, code that performs a wake up normally follows something like this: Secondly, code that performs a wake up normally follows something like this: