redonkable
/
alistair23-linux
1
0
Fork 0
Code Releases Activity

docs/completion.txt: Fix a couple of punctuation nits 

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 <john.garry@huawei.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
hifive-unleashed-5.1
John Garry 2018-10-10 22:56:32 +08:00 committed by Jonathan Corbet
parent 9dc84ee6e5
commit bc0e5262d3
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/scheduler/completion.txt
View File

@ -116,7 +116,7 @@ A typical usage scenario is:
This is not implying any temporal order on wait_for_completion() and the 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 call to complete() - if the call to complete() happened before the call
to wait_for_completion() then the waiting side simply will continue 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(). completion is signaled by complete().
Note that wait_for_completion() is calling spin_lock_irq()/spin_unlock_irq(), Note that wait_for_completion() is calling spin_lock_irq()/spin_unlock_irq(),
@ -131,7 +131,7 @@ wait_for_completion():
The default behavior is to wait without a timeout and to mark the task as 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 uninterruptible. wait_for_completion() and its variants are only safe
in process context (as they can sleep) but not in atomic context, 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 try_wait_for_completion() below for handling completion in atomic/interrupt
context. context.
@ -224,7 +224,7 @@ queue spinlock. Any such concurrent calls to complete() or complete_all()
probably are a design bug. probably are a design bug.
Signaling completion from hard-irq context is fine as it will appropriately 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(): try_wait_for_completion()/completion_done():