diff options
| author | Thomas Gleixner <tglx@linutronix.de> | 2016-06-01 10:43:29 +0200 |
|---|---|---|
| committer | Thomas Gleixner <tglx@linutronix.de> | 2016-09-05 17:20:18 +0200 |
| commit | e8b61b3f2c5d3ee7804766621c91f38737d38105 (patch) | |
| tree | 3b72e11e9bfc297e9a5ccb7de8b37dc35ea3d86f /kernel/futex.c | |
| parent | b2d4c2edb2e4f89aaf85449dee3b87fbf0f8a4d4 (diff) | |
| download | linux-e8b61b3f2c5d3ee7804766621c91f38737d38105.tar.gz linux-e8b61b3f2c5d3ee7804766621c91f38737d38105.tar.bz2 linux-e8b61b3f2c5d3ee7804766621c91f38737d38105.zip | |
futex: Add some more function commentry
Add some more comments and reformat existing ones to kernel doc style.
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Signed-off-by: Sebastian Andrzej Siewior <bigeasy@linutronix.de>
Reviewed-by: Darren Hart <dvhart@linux.intel.com>
Link: http://lkml.kernel.org/r/1464770609-30168-1-git-send-email-bigeasy@linutronix.de
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Diffstat (limited to 'kernel/futex.c')
| -rw-r--r-- | kernel/futex.c | 15 |
1 files changed, 12 insertions, 3 deletions
diff --git a/kernel/futex.c b/kernel/futex.c index 46cb3a301bc1..2c4be467fecd 100644 --- a/kernel/futex.c +++ b/kernel/futex.c @@ -381,8 +381,12 @@ static inline int hb_waiters_pending(struct futex_hash_bucket *hb) #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) { @@ -392,7 +396,12 @@ static struct futex_hash_bucket *hash_futex(union futex_key *key) return &futex_queues[hash & (futex_hashsize - 1)]; } -/* + +/** + * match_futex - Check whether two futex keys are equal + * @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) |