diff options
author | Randy Dunlap <randy.dunlap@oracle.com> | 2010-10-26 17:17:25 -0400 |
---|---|---|
committer | Linus Torvalds <torvalds@linux-foundation.org> | 2010-10-26 20:32:41 -0400 |
commit | ee2f154a598e96df2ebb01648a7699373bc085c7 (patch) | |
tree | 30de15c8024271552a4fd5bf9fc813c0787ea91c /include/linux/completion.h | |
parent | 003bb8ab7cecbfd1830bbccf9c6a9e2047d27c5c (diff) |
docbook: add more wait/wake/completion to device-drivers docbook
Add more wait, wake, and completion interfaces to the device-drivers
docbook.
Fix kernel-doc notation in the added files.
Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Diffstat (limited to 'include/linux/completion.h')
-rw-r--r-- | include/linux/completion.h | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/include/linux/completion.h b/include/linux/completion.h index 51e3145196f6..36d57f74cd01 100644 --- a/include/linux/completion.h +++ b/include/linux/completion.h | |||
@@ -10,7 +10,7 @@ | |||
10 | 10 | ||
11 | #include <linux/wait.h> | 11 | #include <linux/wait.h> |
12 | 12 | ||
13 | /** | 13 | /* |
14 | * struct completion - structure used to maintain state for a "completion" | 14 | * struct completion - structure used to maintain state for a "completion" |
15 | * | 15 | * |
16 | * This is the opaque structure used to maintain the state for a "completion". | 16 | * This is the opaque structure used to maintain the state for a "completion". |
@@ -34,7 +34,7 @@ struct completion { | |||
34 | ({ init_completion(&work); work; }) | 34 | ({ init_completion(&work); work; }) |
35 | 35 | ||
36 | /** | 36 | /** |
37 | * DECLARE_COMPLETION: - declare and initialize a completion structure | 37 | * DECLARE_COMPLETION - declare and initialize a completion structure |
38 | * @work: identifier for the completion structure | 38 | * @work: identifier for the completion structure |
39 | * | 39 | * |
40 | * This macro declares and initializes a completion structure. Generally used | 40 | * This macro declares and initializes a completion structure. Generally used |
@@ -50,7 +50,7 @@ struct completion { | |||
50 | * are on the kernel stack: | 50 | * are on the kernel stack: |
51 | */ | 51 | */ |
52 | /** | 52 | /** |
53 | * DECLARE_COMPLETION_ONSTACK: - declare and initialize a completion structure | 53 | * DECLARE_COMPLETION_ONSTACK - declare and initialize a completion structure |
54 | * @work: identifier for the completion structure | 54 | * @work: identifier for the completion structure |
55 | * | 55 | * |
56 | * This macro declares and initializes a completion structure on the kernel | 56 | * This macro declares and initializes a completion structure on the kernel |
@@ -64,7 +64,7 @@ struct completion { | |||
64 | #endif | 64 | #endif |
65 | 65 | ||
66 | /** | 66 | /** |
67 | * init_completion: - Initialize a dynamically allocated completion | 67 | * init_completion - Initialize a dynamically allocated completion |
68 | * @x: completion structure that is to be initialized | 68 | * @x: completion structure that is to be initialized |
69 | * | 69 | * |
70 | * This inline function will initialize a dynamically created completion | 70 | * This inline function will initialize a dynamically created completion |
@@ -92,7 +92,7 @@ extern void complete(struct completion *); | |||
92 | extern void complete_all(struct completion *); | 92 | extern void complete_all(struct completion *); |
93 | 93 | ||
94 | /** | 94 | /** |
95 | * INIT_COMPLETION: - reinitialize a completion structure | 95 | * INIT_COMPLETION - reinitialize a completion structure |
96 | * @x: completion structure to be reinitialized | 96 | * @x: completion structure to be reinitialized |
97 | * | 97 | * |
98 | * This macro should be used to reinitialize a completion structure so it can | 98 | * This macro should be used to reinitialize a completion structure so it can |