Re: [patch V2 1/7] futex: Add some more function commentry

[Darren Hart]

On Thu, May 05, 2016 at 08:44:03PM -0000, Thomas Gleixner wrote:
> Add some more comments and reformat existing ones to kernel doc style.
> 
> Signed-off-by: Thomas Gleixner <tglx@xxxxxxxxxxxxx>
> ---
>  kernel/futex.c |   15 ++++++++++++---
>  1 file changed, 12 insertions(+), 3 deletions(-)
> 
> --- a/kernel/futex.c
> +++ b/kernel/futex.c
> @@ -373,8 +373,12 @@ static inline int hb_waiters_pending(str
>  #endif
>  }
>  
> -/*
> - * We hash on the keys returned from get_futex_key (see below).
> +/**
> + * hash_futex - Return the hash bucket in the global hash
> + * @key:	Pointer to the futex key for which the hash is calculated
> + *
> + * We hash on the keys returned from get_futex_key (see below) and return the
> + * corresponding hash bucket in the global hash.
>   */
>  static struct futex_hash_bucket *hash_futex(union futex_key *key)
>  {
> @@ -384,7 +388,12 @@ static struct futex_hash_bucket *hash_fu
>  	return &futex_queues[hash & (futex_hashsize - 1)];
>  }
>  
> -/*
> +
> +/**
> + * match_futex - Check whether to futex keys are equal

s/to/two/

Otherwise:

Reviewed-by: Darren Hart <dvhart@xxxxxxxxxxxxxxx>

> + * @key1:	Pointer to key1
> + * @key2:	Pointer to key2
> + *
>   * Return 1 if two futex_keys are equal, 0 otherwise.
>   */
>  static inline int match_futex(union futex_key *key1, union futex_key *key2)
> 
> 
> 

-- 
Darren Hart
Intel Open Source Technology Center