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=-17.3 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,NICE_REPLY_A,SPF_HELO_NONE,SPF_PASS, URIBL_BLOCKED,USER_AGENT_SANE_1 autolearn=unavailable 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 DF89CC433E0 for ; Tue, 30 Mar 2021 21:35:57 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id B0FDD6192C for ; Tue, 30 Mar 2021 21:35:57 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232545AbhC3Vf0 (ORCPT ); Tue, 30 Mar 2021 17:35:26 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:53236 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232774AbhC3VfY (ORCPT ); Tue, 30 Mar 2021 17:35:24 -0400 Received: from casper.infradead.org (casper.infradead.org [IPv6:2001:8b0:10b:1236::1]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 3FDD2C061574; Tue, 30 Mar 2021 14:35:24 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=casper.20170209; h=Content-Transfer-Encoding:Content-Type: In-Reply-To:MIME-Version:Date:Message-ID:From:References:Cc:To:Subject:Sender :Reply-To:Content-ID:Content-Description; bh=z7gpjKduYgeN6oL2kpf0goTjGuX7Jirh6bppui9tmTw=; b=l+hnoP3v0qdie0iPZDvdZiuoBW Iyfz7J0yph9CuU+XlaLvnSo8ku2k7KDd/d+krMIST6s9Fyv/egtQgT3W7t7p6hjWDOv5kSjalw4Ec 2UXpr36d7MW1htLT+rvF7dYmYqKfWrD8SaZnI3uaA/Y7LaB/HdZimrmGUV+X/FU5LQdQZd9MAmGR6 NDsGb+rIi8T+u5KgbpaQ6qj8t/KO6X+y5CJJ4Kc2mMI6iyux8Pz8u4cQL9Ig/clytqOfua63wAsCW wJwqt1HMRxUeNDwlSLKt9CLSomizp6PDlJyp6MMwFMzNOVpaEZ8iCg/EbLmz5xPDO9FjDdjhTG8xR N8Wq8hZw==; Received: from [2601:1c0:6280:3f0::4557] by casper.infradead.org with esmtpsa (Exim 4.94 #2 (Red Hat Linux)) id 1lRLyp-003dqg-0Z; Tue, 30 Mar 2021 21:33:07 +0000 Subject: Re: [PATCH] x86/platform/intel/quark: fix incorrect kernel-doc comment syntax in files To: Aditya Srivastava , linux-kernel@vger.kernel.org Cc: lukas.bulwahn@gmail.com, dvhart@infradead.org, andy@infradead.org, tglx@linutronix.de, mingo@redhat.com, bp@alien8.de, x86@kernel.org, hpa@zytor.com, linux-kernel-mentees@lists.linuxfoundation.org, linux-doc@vger.kernel.org, platform-driver-x86@vger.kernel.org References: <20210330213022.28769-1-yashsri421@gmail.com> From: Randy Dunlap Message-ID: <1f37b726-7f03-99dc-546f-7d33a1f2c6c9@infradead.org> Date: Tue, 30 Mar 2021 14:32:46 -0700 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.8.0 MIME-Version: 1.0 In-Reply-To: <20210330213022.28769-1-yashsri421@gmail.com> Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: 7bit Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On 3/30/21 2:30 PM, Aditya Srivastava wrote: > The opening comment mark '/**' is used for highlighting the beginning of > kernel-doc comments. > There are certain files in arch/x86/platform/intel-quark, which follow this > syntax, but the content inside does not comply with kernel-doc. > Such lines were probably not meant for kernel-doc parsing, but are parsed > due to the presence of kernel-doc like comment syntax(i.e, '/**'), which > causes unexpected warnings from kernel-doc. > > E.g., presence of kernel-doc like comment in the header lines for > arch/x86/platform/intel-quark/imr.c causes these warnings: > "warning: Function parameter or member 'fmt' not described in 'pr_fmt'" > "warning: expecting prototype for c(). Prototype was for pr_fmt() instead" > > Similarly for arch/x86/platform/intel-quark/imr_selftest.c too. > > Provide a simple fix by replacing these occurrences with general comment > format, i.e. '/*', to prevent kernel-doc from parsing it. > > Signed-off-by: Aditya Srivastava Acked-by: Randy Dunlap > --- > * Applies perfectly on next-20210326 > > arch/x86/platform/intel-quark/imr.c | 2 +- > arch/x86/platform/intel-quark/imr_selftest.c | 2 +- > 2 files changed, 2 insertions(+), 2 deletions(-) > > diff --git a/arch/x86/platform/intel-quark/imr.c b/arch/x86/platform/intel-quark/imr.c > index 122e0f37b1f5..d3d456925b2a 100644 > --- a/arch/x86/platform/intel-quark/imr.c > +++ b/arch/x86/platform/intel-quark/imr.c > @@ -1,5 +1,5 @@ > // SPDX-License-Identifier: GPL-2.0-only > -/** > +/* > * imr.c -- Intel Isolated Memory Region driver > * > * Copyright(c) 2013 Intel Corporation. > diff --git a/arch/x86/platform/intel-quark/imr_selftest.c b/arch/x86/platform/intel-quark/imr_selftest.c > index 570e3062faac..761f3689f60a 100644 > --- a/arch/x86/platform/intel-quark/imr_selftest.c > +++ b/arch/x86/platform/intel-quark/imr_selftest.c > @@ -1,5 +1,5 @@ > // SPDX-License-Identifier: GPL-2.0 > -/** > +/* > * imr_selftest.c -- Intel Isolated Memory Region self-test driver > * > * Copyright(c) 2013 Intel Corporation. > -- ~Randy 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=-15.1 required=3.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,NICE_REPLY_A,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_SANE_1 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 4FB3DC433DB for ; Tue, 30 Mar 2021 21:35:42 +0000 (UTC) Received: from smtp2.osuosl.org (smtp2.osuosl.org [140.211.166.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id D8F616192C for ; Tue, 30 Mar 2021 21:35:41 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org D8F616192C Authentication-Results: mail.kernel.org; dmarc=none (p=none dis=none) header.from=infradead.org Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=linux-kernel-mentees-bounces@lists.linuxfoundation.org Received: from localhost (localhost [127.0.0.1]) by smtp2.osuosl.org (Postfix) with ESMTP id 99130403A9; Tue, 30 Mar 2021 21:35:41 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from smtp2.osuosl.org ([127.0.0.1]) by localhost (smtp2.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id K6YrIVxIa32I; Tue, 30 Mar 2021 21:35:39 +0000 (UTC) Received: from lists.linuxfoundation.org (lf-lists.osuosl.org [IPv6:2605:bc80:3010:104::8cd3:938]) by smtp2.osuosl.org (Postfix) with ESMTP id 9C1DE401EB; Tue, 30 Mar 2021 21:35:39 +0000 (UTC) Received: from lf-lists.osuosl.org (localhost [127.0.0.1]) by lists.linuxfoundation.org (Postfix) with ESMTP id 7BC55C000C; Tue, 30 Mar 2021 21:35:39 +0000 (UTC) Received: from smtp3.osuosl.org (smtp3.osuosl.org [140.211.166.136]) by lists.linuxfoundation.org (Postfix) with ESMTP id 7BA2DC000A for ; Tue, 30 Mar 2021 21:35:38 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by smtp3.osuosl.org (Postfix) with ESMTP id 548E260881 for ; Tue, 30 Mar 2021 21:35:38 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Authentication-Results: smtp3.osuosl.org (amavisd-new); dkim=pass (2048-bit key) header.d=infradead.org Received: from smtp3.osuosl.org ([127.0.0.1]) by localhost (smtp3.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id SaR55ixcJcVm for ; Tue, 30 Mar 2021 21:35:36 +0000 (UTC) X-Greylist: domain auto-whitelisted by SQLgrey-1.8.0 Received: from casper.infradead.org (casper.infradead.org [IPv6:2001:8b0:10b:1236::1]) by smtp3.osuosl.org (Postfix) with ESMTPS id 4F99D6078C for ; Tue, 30 Mar 2021 21:35:36 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=casper.20170209; h=Content-Transfer-Encoding:Content-Type: In-Reply-To:MIME-Version:Date:Message-ID:From:References:Cc:To:Subject:Sender :Reply-To:Content-ID:Content-Description; bh=z7gpjKduYgeN6oL2kpf0goTjGuX7Jirh6bppui9tmTw=; b=l+hnoP3v0qdie0iPZDvdZiuoBW Iyfz7J0yph9CuU+XlaLvnSo8ku2k7KDd/d+krMIST6s9Fyv/egtQgT3W7t7p6hjWDOv5kSjalw4Ec 2UXpr36d7MW1htLT+rvF7dYmYqKfWrD8SaZnI3uaA/Y7LaB/HdZimrmGUV+X/FU5LQdQZd9MAmGR6 NDsGb+rIi8T+u5KgbpaQ6qj8t/KO6X+y5CJJ4Kc2mMI6iyux8Pz8u4cQL9Ig/clytqOfua63wAsCW wJwqt1HMRxUeNDwlSLKt9CLSomizp6PDlJyp6MMwFMzNOVpaEZ8iCg/EbLmz5xPDO9FjDdjhTG8xR N8Wq8hZw==; Received: from [2601:1c0:6280:3f0::4557] by casper.infradead.org with esmtpsa (Exim 4.94 #2 (Red Hat Linux)) id 1lRLyp-003dqg-0Z; Tue, 30 Mar 2021 21:33:07 +0000 Subject: Re: [PATCH] x86/platform/intel/quark: fix incorrect kernel-doc comment syntax in files To: Aditya Srivastava , linux-kernel@vger.kernel.org References: <20210330213022.28769-1-yashsri421@gmail.com> From: Randy Dunlap Message-ID: <1f37b726-7f03-99dc-546f-7d33a1f2c6c9@infradead.org> Date: Tue, 30 Mar 2021 14:32:46 -0700 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.8.0 MIME-Version: 1.0 In-Reply-To: <20210330213022.28769-1-yashsri421@gmail.com> Content-Language: en-US Cc: hpa@zytor.com, linux-doc@vger.kernel.org, x86@kernel.org, platform-driver-x86@vger.kernel.org, mingo@redhat.com, bp@alien8.de, dvhart@infradead.org, tglx@linutronix.de, linux-kernel-mentees@lists.linuxfoundation.org, andy@infradead.org X-BeenThere: linux-kernel-mentees@lists.linuxfoundation.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: linux-kernel-mentees-bounces@lists.linuxfoundation.org Sender: "Linux-kernel-mentees" On 3/30/21 2:30 PM, Aditya Srivastava wrote: > The opening comment mark '/**' is used for highlighting the beginning of > kernel-doc comments. > There are certain files in arch/x86/platform/intel-quark, which follow this > syntax, but the content inside does not comply with kernel-doc. > Such lines were probably not meant for kernel-doc parsing, but are parsed > due to the presence of kernel-doc like comment syntax(i.e, '/**'), which > causes unexpected warnings from kernel-doc. > > E.g., presence of kernel-doc like comment in the header lines for > arch/x86/platform/intel-quark/imr.c causes these warnings: > "warning: Function parameter or member 'fmt' not described in 'pr_fmt'" > "warning: expecting prototype for c(). Prototype was for pr_fmt() instead" > > Similarly for arch/x86/platform/intel-quark/imr_selftest.c too. > > Provide a simple fix by replacing these occurrences with general comment > format, i.e. '/*', to prevent kernel-doc from parsing it. > > Signed-off-by: Aditya Srivastava Acked-by: Randy Dunlap > --- > * Applies perfectly on next-20210326 > > arch/x86/platform/intel-quark/imr.c | 2 +- > arch/x86/platform/intel-quark/imr_selftest.c | 2 +- > 2 files changed, 2 insertions(+), 2 deletions(-) > > diff --git a/arch/x86/platform/intel-quark/imr.c b/arch/x86/platform/intel-quark/imr.c > index 122e0f37b1f5..d3d456925b2a 100644 > --- a/arch/x86/platform/intel-quark/imr.c > +++ b/arch/x86/platform/intel-quark/imr.c > @@ -1,5 +1,5 @@ > // SPDX-License-Identifier: GPL-2.0-only > -/** > +/* > * imr.c -- Intel Isolated Memory Region driver > * > * Copyright(c) 2013 Intel Corporation. > diff --git a/arch/x86/platform/intel-quark/imr_selftest.c b/arch/x86/platform/intel-quark/imr_selftest.c > index 570e3062faac..761f3689f60a 100644 > --- a/arch/x86/platform/intel-quark/imr_selftest.c > +++ b/arch/x86/platform/intel-quark/imr_selftest.c > @@ -1,5 +1,5 @@ > // SPDX-License-Identifier: GPL-2.0 > -/** > +/* > * imr_selftest.c -- Intel Isolated Memory Region self-test driver > * > * Copyright(c) 2013 Intel Corporation. > -- ~Randy _______________________________________________ Linux-kernel-mentees mailing list Linux-kernel-mentees@lists.linuxfoundation.org https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees