]> git.ipfire.org Git - thirdparty/linux.git/commitdiff
memory-barriers.txt: Sort wait_event* and wait_on_bit* list alphabetically
authorAkira Yokosawa <akiyks@gmail.com>
Wed, 5 Nov 2025 03:17:28 +0000 (12:17 +0900)
committerPaul E. McKenney <paulmck@kernel.org>
Sun, 9 Nov 2025 03:02:26 +0000 (19:02 -0800)
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>
Reviewed-by: HÃ¥kon Bugge <haakon.bugge@oracle.com>
Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
Documentation/memory-barriers.txt

index 1d164e0057769c096ba49bd5ed543b91846d9e4a..61b7317bcf2ebb11b71ef6b1daddaebfe72bda8c 100644 (file)
@@ -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: