From patchwork Sun Jan 21 05:18:44 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 13524500 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 7DED7C47DAF for ; Sun, 21 Jan 2024 05:19:16 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender: Content-Transfer-Encoding:Content-Type:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:MIME-Version:Message-ID:Date:Subject:Cc :To:From:Reply-To:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:In-Reply-To:References: List-Owner; bh=g7ygTBDsOMVQPSrAZP2NESTV2nEHP2mAlfdocgeN0Po=; b=a/EEryon5CQaaA x7UsxV1NLV9SIrG94oLDjSueDA/81iImog0139LvItHc4KLR57HTO4m83m7gRFRjjArcJ8QL/VivE BXPfszehrHmZ8LhYsW3sIRpbkGOaOVJkWbud937sSmrn8fFwuTr6BvTke4epkCLW1+RsukS+CgXJ5 bDaPFmjL5k1DxMoWMtzoBlmNPD7osnn48ucdfOCnruljZyTtyxiTb+k77mOLfOY9ep0MfIhc05RTX +SppcvgzQekjWxR6SfX88Swoz/JCyiqeXM5Yf1WA3MCFkUGwAVUgcaT/oiln2cupztX7ZiqK5U8Bs KgMtU/0rM/h4qzsRofCA==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.96 #2 (Red Hat Linux)) id 1rRQEK-008uMI-1a; Sun, 21 Jan 2024 05:18:48 +0000 Received: from [50.53.50.0] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.96 #2 (Red Hat Linux)) id 1rRQEI-008uM0-10; Sun, 21 Jan 2024 05:18:46 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Cc: Randy Dunlap , =?utf-8?q?Emilio_L=C3=B3pez?= , Michael Turquette , Stephen Boyd , linux-clk@vger.kernel.org, Chen-Yu Tsai , Jernej Skrabec , Samuel Holland , linux-arm-kernel@lists.infradead.org, linux-sunxi@lists.linux.dev Subject: [PATCH] clk: sunxi: sun9i-cpus: fix kernel-doc warnings Date: Sat, 20 Jan 2024 21:18:44 -0800 Message-ID: <20240121051845.17603-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.43.0 MIME-Version: 1.0 X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org Move the function description kernel-doc comment to immediately above the function implementation, correct the function name in the comment, then add a function parameter description to prevent these kernel-doc warnings: drivers/clk/sunxi/clk-sun9i-cpus.c:25: warning: expecting prototype for sun9i_a80_cpus_clk_setup(). Prototype was for SUN9I_CPUS_MAX_PARENTS() instead clk-sun9i-cpus.c:184: warning: Function parameter or struct member 'node' not described in 'sun9i_a80_cpus_setup' Signed-off-by: Randy Dunlap Cc: Emilio López Cc: Michael Turquette Cc: Stephen Boyd Cc: linux-clk@vger.kernel.org Cc: Chen-Yu Tsai Cc: Jernej Skrabec Cc: Samuel Holland Cc: linux-arm-kernel@lists.infradead.org Cc: linux-sunxi@lists.linux.dev Reviewed-by: Andre Przywara Acked-by: Jernej Skrabec --- drivers/clk/sunxi/clk-sun9i-cpus.c | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff -- a/drivers/clk/sunxi/clk-sun9i-cpus.c b/drivers/clk/sunxi/clk-sun9i-cpus.c --- a/drivers/clk/sunxi/clk-sun9i-cpus.c +++ b/drivers/clk/sunxi/clk-sun9i-cpus.c @@ -18,9 +18,6 @@ static DEFINE_SPINLOCK(sun9i_a80_cpus_lock); -/** - * sun9i_a80_cpus_clk_setup() - Setup function for a80 cpus composite clk - */ #define SUN9I_CPUS_MAX_PARENTS 4 #define SUN9I_CPUS_MUX_PARENT_PLL4 3 @@ -180,6 +177,10 @@ static const struct clk_ops sun9i_a80_cp .set_rate = sun9i_a80_cpus_clk_set_rate, }; +/** + * sun9i_a80_cpus_setup() - Setup function for a80 cpus composite clk + * @node: &struct device_node for the clock + */ static void sun9i_a80_cpus_setup(struct device_node *node) { const char *clk_name = node->name;