From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S933237AbcIEPZU (ORCPT ); Mon, 5 Sep 2016 11:25:20 -0400 Received: from terminus.zytor.com ([198.137.202.10]:41968 "EHLO terminus.zytor.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S932448AbcIEPZT (ORCPT ); Mon, 5 Sep 2016 11:25:19 -0400 Date: Mon, 5 Sep 2016 08:25:10 -0700 From: tip-bot for Thomas Gleixner Message-ID: Cc: hpa@zytor.com, dvhart@linux.intel.com, linux-kernel@vger.kernel.org, bigeasy@linutronix.de, tglx@linutronix.de, mingo@kernel.org Reply-To: bigeasy@linutronix.de, mingo@kernel.org, tglx@linutronix.de, hpa@zytor.com, dvhart@linux.intel.com, linux-kernel@vger.kernel.org In-Reply-To: <1464770609-30168-1-git-send-email-bigeasy@linutronix.de> References: <1464770609-30168-1-git-send-email-bigeasy@linutronix.de> To: linux-tip-commits@vger.kernel.org Subject: [tip:locking/core] futex: Add some more function commentry Git-Commit-ID: e8b61b3f2c5d3ee7804766621c91f38737d38105 X-Mailer: tip-git-log-daemon Robot-ID: Robot-Unsubscribe: Contact to get blacklisted from these emails MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Type: text/plain; charset=UTF-8 Content-Disposition: inline Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Commit-ID: e8b61b3f2c5d3ee7804766621c91f38737d38105 Gitweb: http://git.kernel.org/tip/e8b61b3f2c5d3ee7804766621c91f38737d38105 Author: Thomas Gleixner AuthorDate: Wed, 1 Jun 2016 10:43:29 +0200 Committer: Thomas Gleixner CommitDate: Mon, 5 Sep 2016 17:20:18 +0200 futex: Add some more function commentry Add some more comments and reformat existing ones to kernel doc style. Signed-off-by: Thomas Gleixner Signed-off-by: Sebastian Andrzej Siewior Reviewed-by: Darren Hart Link: http://lkml.kernel.org/r/1464770609-30168-1-git-send-email-bigeasy@linutronix.de Signed-off-by: Thomas Gleixner --- kernel/futex.c | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/kernel/futex.c b/kernel/futex.c index 46cb3a3..2c4be46 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)