From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1753597AbcDBLLu (ORCPT ); Sat, 2 Apr 2016 07:11:50 -0400 Received: from www.linutronix.de ([62.245.132.108]:57070 "EHLO Galois.linutronix.de" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751353AbcDBLKz (ORCPT ); Sat, 2 Apr 2016 07:10:55 -0400 Message-Id: <20160402110035.466678382@linutronix.de> User-Agent: quilt/0.63-1 Date: Sat, 02 Apr 2016 11:09:16 -0000 From: Thomas Gleixner To: LKML Cc: Sebastian Andrzej Siewior , Darren Hart , Peter Zijlstra , Ingo Molnar , Michael Kerrisk , Davidlohr Bueso , Chris Mason , "Carlos O'Donell" , Torvald Riegel , Eric Dumazet Subject: [RFC patch 2/7] futex: Add some more function commentry References: <20160402095108.894519835@linutronix.de> MIME-Version: 1.0 Content-Type: text/plain; charset=ISO-8859-15 Content-Disposition: inline; filename=futex--Add-some-more-function-commentry.patch X-Linutronix-Spam-Score: -1.0 X-Linutronix-Spam-Level: - X-Linutronix-Spam-Status: No , -1.0 points, 5.0 required, ALL_TRUSTED=-1,SHORTCIRCUIT=-0.0001 Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Add some more comments and reformat existing ones to kernel doc style. Signed-off-by: Thomas Gleixner --- kernel/futex.c | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) Index: b/kernel/futex.c =================================================================== --- a/kernel/futex.c +++ b/kernel/futex.c @@ -402,8 +402,12 @@ static inline void hb_remove_q(struct fu plist_del(&q->list, &hb->chain); } -/* - * 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) { @@ -413,7 +417,12 @@ static struct futex_hash_bucket *hash_fu return &futex_queues[hash & (futex_hashsize - 1)]; } -/* + +/** + * match_futex - Check whether to 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)