Received: by 2002:a05:6a10:8c0a:0:0:0:0 with SMTP id go10csp941332pxb; Thu, 28 Jan 2021 04:23:22 -0800 (PST) X-Google-Smtp-Source: ABdhPJyf2fwdYQuXDry5tIvxwloksqrYDGezPzAXkQyiymVsnLK4wrK7oX7FahNLGCqUbPrTLm20 X-Received: by 2002:a17:906:a153:: with SMTP id bu19mr2036969ejb.287.1611836602164; Thu, 28 Jan 2021 04:23:22 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1611836602; cv=none; d=google.com; s=arc-20160816; b=k1BgTtwmplaOoxVcG6tPQd373D7sG0bPZkWb/KKC/ADH/98WajI1WvPAnWTTklcS+u 1bQR4npFFBQczxpKEzYA1YhoQ4InzoANZ0bJuII4x9G+oGafRQdgwoSDcHoXy/yEN5LR OdsBqaw1r7HACCyOpvOgsSnYSd3NJzpVdZlPvY4/3T075ePm+a5oM3Wo3E5yW1P/u1Dr dI3xqYo1F/s5G5Dk3A5zeP2OXCyiDk22Y+BRl7ETUzvHtQEhWbFVAXPequcpTmUt8POb jBCiqnjVVBfwGI1SuBqsmA+W17VTUhSdy3SRMsahBtVZHT/pSn+KblNtEwJ/CfZ5FsJ6 9BKw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:robot-unsubscribe :robot-id:message-id:mime-version:references:in-reply-to:cc:subject :to:reply-to:sender:from:dkim-signature:dkim-signature:date; bh=trpTr5Kt6dyOcuEAnVdH0aFyDdUBi+2DCuy6JjrYcbI=; b=DLHPYOWTfv6a75/1oXQwNJUbOtviryXTwysxrTiXrWivZhjAPKBhddTXqCgLj7anoa thS/3kpoha+RLu+ije+OZWbhLlZ/FenJPDZVc0Mprzeaw1TxFZZ/7ewlwW1JwOTTo0cc F86usxwWJAu9T3llHwDLtj9RHhBRiny5vliPfxk18uOXv0qxbkaZ8cw9Jhc6KsiIgvLP YEVScb0kYCoH2wcuzRa067f3lLqpnftrRKmrDnj1bxd8vNFYxhttTNPUIYduSP0GCgOT iqGtecEctzGZOYnCgXjN5OJLhcRLvxow1Z/rsp73eGfLI6aK+ozq0Znkk1Xhnmyty/74 PJ3w== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linutronix.de header.s=2020 header.b=dAsjuBJO; dkim=neutral (no key) header.i=@linutronix.de header.b=eOVuruo8; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=linutronix.de Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id q15si2875539edr.397.2021.01.28.04.22.58; Thu, 28 Jan 2021 04:23:22 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; Authentication-Results: mx.google.com; dkim=pass header.i=@linutronix.de header.s=2020 header.b=dAsjuBJO; dkim=neutral (no key) header.i=@linutronix.de header.b=eOVuruo8; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=linutronix.de Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231250AbhA1MWW (ORCPT + 99 others); Thu, 28 Jan 2021 07:22:22 -0500 Received: from Galois.linutronix.de ([193.142.43.55]:34756 "EHLO galois.linutronix.de" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231178AbhA1MWT (ORCPT ); Thu, 28 Jan 2021 07:22:19 -0500 Date: Thu, 28 Jan 2021 12:21:36 -0000 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linutronix.de; s=2020; t=1611836497; h=from:from:sender:sender:reply-to:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=trpTr5Kt6dyOcuEAnVdH0aFyDdUBi+2DCuy6JjrYcbI=; b=dAsjuBJO3JBaZxSNHCZBNQntmN1/5W2H7oEzyAMWOIs0NpRftMqPRuyNA3diT2ymJ6xGpU aoPTEpO1d7H7MeEd92hWeQi5gj2sPOZ64pe6BRT5JwnKdP+VgpvhuoF0N374NhWTZVxcTW HSZv38oIrmYRjKDmLG9wUNOuocZoErNqXs15deXWJ6dsu68/mL0G7qc0uvurYFsX51hwHe 0ac4cxyzKHYwj799akte2cLYUMu0zum4wXBLj6x7XUwFtfEpuhErj8z20JMhiz49ip5FVa nldIu1yy+ADDl/Cu5TyZOOl3ZMiFHwezBNhz/d9oElUoforlVib28rDtLgjmfg== DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=linutronix.de; s=2020e; t=1611836497; h=from:from:sender:sender:reply-to:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=trpTr5Kt6dyOcuEAnVdH0aFyDdUBi+2DCuy6JjrYcbI=; b=eOVuruo85Tf6Q46WXOGYDzuZJD2mqkrylbvsieO7XilfeKT2tkLY5wEONYZV+uhE9L8Wo4 X5c8b78sAvDhJ2BQ== From: "tip-bot2 for Alex Shi" Sender: tip-bot2@linutronix.de Reply-to: linux-kernel@vger.kernel.org To: linux-tip-commits@vger.kernel.org Subject: [tip: locking/core] locking/rtmutex: Add missing kernel-doc markup Cc: Alex Shi , Thomas Gleixner , Will Deacon , x86@kernel.org, linux-kernel@vger.kernel.org In-Reply-To: <1605257895-5536-2-git-send-email-alex.shi@linux.alibaba.com> References: <1605257895-5536-2-git-send-email-alex.shi@linux.alibaba.com> MIME-Version: 1.0 Message-ID: <161183649616.23325.8512729812885530815.tip-bot2@tip-bot2> Robot-ID: Robot-Unsubscribe: Contact to get blacklisted from these emails Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 7bit Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org The following commit has been merged into the locking/core branch of tip: Commit-ID: bf594bf400016a1ac58c753bcc0393a39c36f669 Gitweb: https://git.kernel.org/tip/bf594bf400016a1ac58c753bcc0393a39c36f669 Author: Alex Shi AuthorDate: Fri, 13 Nov 2020 16:58:11 +08:00 Committer: Thomas Gleixner CommitterDate: Thu, 28 Jan 2021 13:20:18 +01:00 locking/rtmutex: Add missing kernel-doc markup To fix the following issues: kernel/locking/rtmutex.c:1612: warning: Function parameter or member 'lock' not described in '__rt_mutex_futex_unlock' kernel/locking/rtmutex.c:1612: warning: Function parameter or member 'wake_q' not described in '__rt_mutex_futex_unlock' kernel/locking/rtmutex.c:1675: warning: Function parameter or member 'name' not described in '__rt_mutex_init' kernel/locking/rtmutex.c:1675: warning: Function parameter or member 'key' not described in '__rt_mutex_init' [ tglx: Change rt lock to rt_mutex for consistency sake ] Signed-off-by: Alex Shi Signed-off-by: Thomas Gleixner Acked-by: Will Deacon Link: https://lore.kernel.org/r/1605257895-5536-2-git-send-email-alex.shi@linux.alibaba.com --- kernel/locking/rtmutex.c | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/kernel/locking/rtmutex.c b/kernel/locking/rtmutex.c index cfdd5b9..a201e5e 100644 --- a/kernel/locking/rtmutex.c +++ b/kernel/locking/rtmutex.c @@ -1604,8 +1604,11 @@ void __sched rt_mutex_unlock(struct rt_mutex *lock) EXPORT_SYMBOL_GPL(rt_mutex_unlock); /** - * Futex variant, that since futex variants do not use the fast-path, can be - * simple and will not need to retry. + * __rt_mutex_futex_unlock - Futex variant, that since futex variants + * do not use the fast-path, can be simple and will not need to retry. + * + * @lock: The rt_mutex to be unlocked + * @wake_q: The wake queue head from which to get the next lock waiter */ bool __sched __rt_mutex_futex_unlock(struct rt_mutex *lock, struct wake_q_head *wake_q) @@ -1662,13 +1665,15 @@ void rt_mutex_destroy(struct rt_mutex *lock) EXPORT_SYMBOL_GPL(rt_mutex_destroy); /** - * __rt_mutex_init - initialize the rt lock + * __rt_mutex_init - initialize the rt_mutex * - * @lock: the rt lock to be initialized + * @lock: The rt_mutex to be initialized + * @name: The lock name used for debugging + * @key: The lock class key used for debugging * - * Initialize the rt lock to unlocked state. + * Initialize the rt_mutex to unlocked state. * - * Initializing of a locked rt lock is not allowed + * Initializing of a locked rt_mutex is not allowed */ void __rt_mutex_init(struct rt_mutex *lock, const char *name, struct lock_class_key *key)