Re: [Fwd: Corrections please ...]

[Stefan Richter <stefanr@s5r6.in-berlin.de>]

Kevin Diggs wrote:
> Files attached this time ...

Alas several MUAs don't quote attachments in replies.  Hence the optimum
would be if you use a MUA which allows to insert text files without
whitespace change.

Also, when you respond on LKML, always use "reply to all" to keep
previous responders in a thread Cc'd.  This is necessary due to the high
volume of LKML, and in order to not force people to subscribe to LKML.


> --- include/linux/completion.h.orig	2008-08-13 00:56:52.000000000 -0700
> +++ include/linux/completion.h	2008-08-18 13:00:23.000000000 -0700
> @@ -10,6 +10,16 @@
>  
>  #include <linux/wait.h>
>  
> +/**
> + * struct completion - structure used to maintain state for a "completion"
> + * @done:  counting variable used to signal completion
> + * @wait:  internal wait queue head; used for locking and synchronization
> + *
> + * This is the structure used to maintain the state for a "completion". See
> + * also:  complete(), wait_for_completion() (and friends _timeout,
> + * _interruptible, _interruptible_timeout, and _killable), init_completion(),
> + * and macros DECLARE_COMPLETION() and INIT_COMPLETION().
> + */
>  struct completion {
>  	unsigned int done;
>  	wait_queue_head_t wait;

.done and .wait are not public AFAIU and should therefore not be
documented as an API.


> @@ -36,6 +46,13 @@
>  # define DECLARE_COMPLETION_ONSTACK(work) DECLARE_COMPLETION(work)
>  #endif
>  
> +/**
> + * init_completion: - Initialize a dynamically allocated completion
> + * @x:  completion structure that is to be initialized
> + *
> + * This inline function will initialize a dynamically created completion
> + * structure.
> + */
>  static inline void init_completion(struct completion *x)
>  {
>  	x->done = 0;

The last sentence is redundant and should be omitted.
-- 
Stefan Richter
-=====-==--- =--- =--==
http://arcgraph.de/sr/