From patchwork Thu Jan 7 02:33:04 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 12002617 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=-18.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_GIT 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 BCB36C433E0 for ; Thu, 7 Jan 2021 02:34:09 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 8ABB323101 for ; Thu, 7 Jan 2021 02:34:09 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726293AbhAGCdx (ORCPT ); Wed, 6 Jan 2021 21:33:53 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:57538 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726260AbhAGCdx (ORCPT ); Wed, 6 Jan 2021 21:33:53 -0500 Received: from merlin.infradead.org (merlin.infradead.org [IPv6:2001:8b0:10b:1231::1]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 49E2BC0612EF; Wed, 6 Jan 2021 18:33:13 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=merlin.20170209; h=Content-Transfer-Encoding:MIME-Version: Message-Id:Date:Subject:Cc:To:From:Sender:Reply-To:Content-Type:Content-ID: Content-Description:In-Reply-To:References; bh=Y/u7YtJmgJ+myd+0PwQt/NtsVGaYOrWxKQtx8mYi/bc=; b=FIXsXBqpw20pAbROFPTssoyBwh ATY/ZZRXzkeWVGh3nXBV5BDQ7+ZZg3YM1c6pFWvYcqtnZusMkX5blzzvJt9aR+tnlcjL5+2O9CD22 3My68g2XA7iC4vs+2V/RyjZy27mSZ7lNQlvWKQU2STUrNnSyGNbIdyPg7ZA5zmqdHcFu9rVZBK4O6 482onnXK+383lQex+WQkcSsJVR0PpgDPgIU1Qv/y0fQYGUH7+MuDrzd/4fCHG3oAJ7yoXBa3RoJq4 H7qw85Ll5odK/oBrmW+Ikav5s2xgoFEZcPOrCEBXoT8lW2T73GmIFUCtHKPAVxScFyRyTESGVmXfk 6NFYKXDw==; Received: from [2601:1c0:6280:3f0::79df] (helo=merlin.infradead.org) by merlin.infradead.org with esmtpsa (Exim 4.92.3 #3 (Red Hat Linux)) id 1kxL6s-0007Iy-6K; Thu, 07 Jan 2021 02:33:10 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Cc: Randy Dunlap , Mike Turquette , Russell King , linux-clk@vger.kernel.org Subject: [PATCH] linux/clk.h: use correct kernel-doc notation for 2 functions Date: Wed, 6 Jan 2021 18:33:04 -0800 Message-Id: <20210107023304.24442-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.26.2 MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-clk@vger.kernel.org Fix kernel-doc notation for 2 functions so that the generated html is correct. Currently it skips all text between the ':' and the '-', so "[un]register a clock rate" is missing. Fixes: 86bcfa2e87c4 ("clk: add pr_debug & kerneldoc around clk notifiers") Signed-off-by: Randy Dunlap Cc: Mike Turquette Cc: Russell King Cc: linux-clk@vger.kernel.org --- include/linux/clk.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) --- linux-next-20210105.orig/include/linux/clk.h +++ linux-next-20210105/include/linux/clk.h @@ -92,7 +92,7 @@ struct clk_bulk_data { #ifdef CONFIG_COMMON_CLK /** - * clk_notifier_register: register a clock rate-change notifier callback + * clk_notifier_register - register a clock rate-change notifier callback * @clk: clock whose rate we are interested in * @nb: notifier block with callback function pointer * @@ -103,7 +103,7 @@ struct clk_bulk_data { int clk_notifier_register(struct clk *clk, struct notifier_block *nb); /** - * clk_notifier_unregister: unregister a clock rate-change notifier callback + * clk_notifier_unregister - unregister a clock rate-change notifier callback * @clk: clock whose rate we are no longer interested in * @nb: notifier block which will be unregistered */