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.5 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,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 853B0C433DB for ; Tue, 30 Mar 2021 00:00:23 +0000 (UTC) Received: from desiato.infradead.org (desiato.infradead.org [90.155.92.199]) (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 258FD6191B for ; Tue, 30 Mar 2021 00:00:23 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 258FD6191B Authentication-Results: mail.kernel.org; dmarc=none (p=none dis=none) header.from=infradead.org Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=desiato.20200630; h=Sender:Content-Transfer-Encoding :Content-Type:List-Subscribe:List-Help:List-Post:List-Archive: List-Unsubscribe:List-Id:In-Reply-To:MIME-Version:Date:Message-ID:From: References:Cc:To:Subject:Reply-To:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Owner; bh=xpehzeCn7YY5ePbhyidFDkPd2KR18dqnpmq+yP1QKQ8=; b=DJaTqzMFTE7qVI+PUR/9JYdOe 710p6LyqZn0I7yW/47ZVpjvpenp1h0ktpFEqEJq3ryxyGLNrEOz5FTLZ8H/eDIqzJo+foGplIRNfx DXXBJaOiYUelMpp6a/pjPxKkVtMirb7F5KHqtkDdaaAtohiFp/qOX3P919AOPdkeiVzsmZCZpikE+ IKoFLzpBpbRTRwBWSHUArPUIDN3cN/eWEXhcn9YdugMm0bJu4ZALCY7Nal4C/G4WcgCE5CrVtp0b2 0QTfZCu1mDXAC7U08nEbwe+lfQU/1EI+J8Hzh8OcKukTrhtfmtgCbfR0tbfAwiqcNheaQylFTZPgO U0qaZCbxw==; Received: from localhost ([::1] helo=desiato.infradead.org) by desiato.infradead.org with esmtp (Exim 4.94 #2 (Red Hat Linux)) id 1lR1mO-00258E-U5; Mon, 29 Mar 2021 23:58:48 +0000 Received: from [2601:1c0:6280:3f0::4557] by desiato.infradead.org with esmtpsa (Exim 4.94 #2 (Red Hat Linux)) id 1lQwQc-0010mF-Mx; Mon, 29 Mar 2021 18:16:04 +0000 Subject: Re: [PATCH] usb: dwc3: st: fix incorrect kernel-doc comment syntax in file To: Aditya Srivastava , patrice.chotard@foss.st.com Cc: lukas.bulwahn@gmail.com, balbi@kernel.org, gregkh@linuxfoundation.org, linux-kernel-mentees@lists.linuxfoundation.org, linux-doc@vger.kernel.org, linux-arm-kernel@lists.infradead.org, linux-usb@vger.kernel.org, linux-kernel@vger.kernel.org References: <20210329132014.24304-1-yashsri421@gmail.com> From: Randy Dunlap Message-ID: Date: Mon, 29 Mar 2021 11:15:50 -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: <20210329132014.24304-1-yashsri421@gmail.com> Content-Language: en-US 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: , Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org On 3/29/21 6:20 AM, Aditya Srivastava wrote: > The opening comment mark '/**' is used for highlighting the beginning of > kernel-doc comments. > The header for drivers/usb/dwc3/dwc3-st.c follows this syntax, but the > content inside does not comply with kernel-doc. > > This line was probably not meant for kernel-doc parsing, but is parsed > due to the presence of kernel-doc like comment syntax(i.e, '/**'), which > causes unexpected warning from kernel-doc: > "warning: expecting prototype for dwc3(). Prototype was for CLKRST_CTRL() instead" > > Provide a simple fix by replacing this occurrence 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 > > drivers/usb/dwc3/dwc3-st.c | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/drivers/usb/dwc3/dwc3-st.c b/drivers/usb/dwc3/dwc3-st.c > index b06b7092b1a2..166b5bde45cb 100644 > --- a/drivers/usb/dwc3/dwc3-st.c > +++ b/drivers/usb/dwc3/dwc3-st.c > @@ -1,5 +1,5 @@ > // SPDX-License-Identifier: GPL-2.0+ > -/** > +/* > * dwc3-st.c Support for dwc3 platform devices on ST Microelectronics platforms > * > * This is a small driver for the dwc3 to provide the glue logic > -- ~Randy _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel