Skip to content

Commit 7f8fcc6

Browse files
akiykspaulmckrcu
authored andcommitted
memory-barriers.txt: Sort wait_event* and wait_on_bit* list alphabetically
Commit 8817270 ("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>
1 parent 3a86608 commit 7f8fcc6

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

Documentation/memory-barriers.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2182,18 +2182,18 @@ set_current_state() may be wrapped by:
21822182

21832183
which therefore also imply a general memory barrier after setting the state.
21842184
The whole sequence above is available in various canned forms, all of which
2185-
interpolate the memory barrier in the right place:
2185+
interpolate the memory barrier in the right place, for example:
21862186

21872187
wait_event();
2188+
wait_event_cmd();
2189+
wait_event_exclusive_cmd();
21882190
wait_event_interruptible();
21892191
wait_event_interruptible_exclusive();
21902192
wait_event_interruptible_timeout();
21912193
wait_event_killable();
21922194
wait_event_timeout();
21932195
wait_on_bit();
21942196
wait_on_bit_lock();
2195-
wait_event_cmd();
2196-
wait_event_exclusive_cmd();
21972197

21982198

21992199
Secondly, code that performs a wake up normally follows something like this:

0 commit comments

Comments
 (0)