From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-14.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH, MAILING_LIST_MULTI,MENTIONS_GIT_HOSTING,SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS, URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 1A337C43457 for ; Fri, 9 Oct 2020 06:37:05 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id B1E7022254 for ; Fri, 9 Oct 2020 06:37:04 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=linutronix.de header.i=@linutronix.de header.b="WZQ0mNUA"; dkim=permerror (0-bit key) header.d=linutronix.de header.i=@linutronix.de header.b="U7b+WPDO" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1732285AbgJIGhA (ORCPT ); Fri, 9 Oct 2020 02:37:00 -0400 Received: from Galois.linutronix.de ([193.142.43.55]:55490 "EHLO galois.linutronix.de" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1732032AbgJIGfk (ORCPT ); Fri, 9 Oct 2020 02:35:40 -0400 Date: Fri, 09 Oct 2020 06:35:37 -0000 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linutronix.de; s=2020; t=1602225338; 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; bh=1WFERfx/rSI7pI3YTD+hhGP8UecLm2meaDGfZwqXK9c=; b=WZQ0mNUA7ZpIY8T+E0sftgg9xnJ0puH7s/6Hdf56o9PtZgu7EMbMS12bebBZwL7l4pR2bK cJl+t3IRN7ZnhDBBOykI3tLcS16F2l9WS66yb92TGrrSN9NvcDp6cyn4pu3YSdCq7cxP98 QHAfNe+ihhlRoUZvfn+OUxAF+TYagWmiU++EkpFb0rMaN6xF7MBKUZUuLIMNeECQXt3AVI VPex1PiU2MfIkvTd7Y9G66YD2x2+X4VVVeeDXFNwqOHD+x/yxqX0ZEdnq0A4AfQ1m/57iF 4HqyHnyPsU0o+o0RjCJcWlskVJh6fg6/4edOB+HCRNTwlAfVVNmZue7qdex7Rg== DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=linutronix.de; s=2020e; t=1602225338; 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; bh=1WFERfx/rSI7pI3YTD+hhGP8UecLm2meaDGfZwqXK9c=; b=U7b+WPDOyzH9YAoED60KUZmEk58gP3GLFyy6D1yZD53bX0Xy+7MZZWD2kHZaTPMYOMGgSo hCBPR0/cbIuvZyBA== From: "tip-bot2 for Tobias Klauser" Sender: tip-bot2@linutronix.de Reply-to: linux-kernel@vger.kernel.org To: linux-tip-commits@vger.kernel.org Subject: [tip: core/rcu] rcu: Fix kerneldoc comments in rcupdate.h Cc: Tobias Klauser , "Paul E. McKenney" , x86 , LKML MIME-Version: 1.0 Message-ID: <160222533771.7002.18170202456845299999.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 core/rcu branch of tip: Commit-ID: 000601bb62330f18dc8f5d2d0b82e9aec3e207c4 Gitweb: https://git.kernel.org/tip/000601bb62330f18dc8f5d2d0b82e9aec3e207c4 Author: Tobias Klauser AuthorDate: Thu, 09 Jul 2020 15:05:59 +02:00 Committer: Paul E. McKenney CommitterDate: Mon, 24 Aug 2020 18:36:08 -07:00 rcu: Fix kerneldoc comments in rcupdate.h This commit fixes the kerneldoc comments for rcu_read_unlock_bh(), rcu_read_unlock_sched() and rcu_head_after_call_rcu() so they e.g. get properly linked in the API documentation. Also add parenthesis after function names to match the notation used in other kerneldoc comments in the same file. Signed-off-by: Tobias Klauser Signed-off-by: Paul E. McKenney --- include/linux/rcupdate.h | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/include/linux/rcupdate.h b/include/linux/rcupdate.h index d15d46d..b47d6b6 100644 --- a/include/linux/rcupdate.h +++ b/include/linux/rcupdate.h @@ -709,8 +709,8 @@ static inline void rcu_read_lock_bh(void) "rcu_read_lock_bh() used illegally while idle"); } -/* - * rcu_read_unlock_bh - marks the end of a softirq-only RCU critical section +/** + * rcu_read_unlock_bh() - marks the end of a softirq-only RCU critical section * * See rcu_read_lock_bh() for more information. */ @@ -751,10 +751,10 @@ static inline notrace void rcu_read_lock_sched_notrace(void) __acquire(RCU_SCHED); } -/* - * rcu_read_unlock_sched - marks the end of a RCU-classic critical section +/** + * rcu_read_unlock_sched() - marks the end of a RCU-classic critical section * - * See rcu_read_lock_sched for more information. + * See rcu_read_lock_sched() for more information. */ static inline void rcu_read_unlock_sched(void) { @@ -945,7 +945,7 @@ static inline void rcu_head_init(struct rcu_head *rhp) } /** - * rcu_head_after_call_rcu - Has this rcu_head been passed to call_rcu()? + * rcu_head_after_call_rcu() - Has this rcu_head been passed to call_rcu()? * @rhp: The rcu_head structure to test. * @f: The function passed to call_rcu() along with @rhp. *