Skip to content

Commit

Permalink
sched/completions/Documentation: Fix a couple of punctuation nits
Browse files Browse the repository at this point in the history
This patch fixes a couple of punctuation nits which can make the document
more correct and readable.

Also missing "()" are added to some function references for consistency.

Signed-off-by: John Garry <[email protected]>
Cc: Linus Torvalds <[email protected]>
Cc: Peter Zijlstra <[email protected]>
Cc: Thomas Gleixner <[email protected]>
Cc: [email protected]
Cc: [email protected]
Link: http://lkml.kernel.org/r/[email protected]
Signed-off-by: Ingo Molnar <[email protected]>
  • Loading branch information
John Garry authored and Ingo Molnar committed Oct 11, 2018
1 parent d0e7d14 commit 7b6abce
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions Documentation/scheduler/completion.txt
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ A typical usage scenario is:
This is not implying any temporal order on wait_for_completion() and the
call to complete() - if the call to complete() happened before the call
to wait_for_completion() then the waiting side simply will continue
immediately as all dependencies are satisfied if not it will block until
immediately as all dependencies are satisfied; if not, it will block until
completion is signaled by complete().

Note that wait_for_completion() is calling spin_lock_irq()/spin_unlock_irq(),
Expand All @@ -131,7 +131,7 @@ wait_for_completion():
The default behavior is to wait without a timeout and to mark the task as
uninterruptible. wait_for_completion() and its variants are only safe
in process context (as they can sleep) but not in atomic context,
interrupt context, with disabled irqs. or preemption is disabled - see also
interrupt context, with disabled irqs, or preemption is disabled - see also
try_wait_for_completion() below for handling completion in atomic/interrupt
context.

Expand Down Expand Up @@ -224,7 +224,7 @@ queue spinlock. Any such concurrent calls to complete() or complete_all()
probably are a design bug.

Signaling completion from hard-irq context is fine as it will appropriately
lock with spin_lock_irqsave/spin_unlock_irqrestore and it will never sleep.
lock with spin_lock_irqsave()/spin_unlock_irqrestore() and it will never sleep.


try_wait_for_completion()/completion_done():
Expand Down

0 comments on commit 7b6abce

Please sign in to comment.