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, 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 D0AD9C433ED for ; Thu, 20 May 2021 18:34:58 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id B2480610CC for ; Thu, 20 May 2021 18:34:58 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S235454AbhETSgT (ORCPT ); Thu, 20 May 2021 14:36:19 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:55134 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233857AbhETSgS (ORCPT ); Thu, 20 May 2021 14:36:18 -0400 Received: from bombadil.infradead.org (bombadil.infradead.org [IPv6:2607:7c80:54:e::133]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 9A33DC061574; Thu, 20 May 2021 11:34:56 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; 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=V+JOfDgV7psnkj9YIO5jH92IC9XuEYZaAjsGKe0XexU=; b=xTP5O2cQQJsLksrvH79y45+Bkv V3Q2iFmUSM/LouF/+t/bmVFzQeKVSNHXIlfXo1Jr92T4rRrsQaTLADiY45CIz2GaX6gdQO6DTxHbX 0yndj/n79FqynwJupu6W4GEVL7VFRF6Xm460otL4s6Gz1J/L66YIzPRWylOMkS0PODnR1RM+t9NiT k6c6yNfsp4nAjTevHLoYByTs+MOWfIkOX62J86cagaD5m1Q3VvH5gSs3F75LDZHJX+20TAYUkDc4O g59DKwmjMI8JC+NaRRO/WTZS5HSdN34JxKrM5ob9p1lfWJbeEJLcUTi7E03hjpGvaxfljBWdZL2PJ AAzICuOg==; Received: from [2601:1c0:6280:3f0::7376] by bombadil.infradead.org with esmtpsa (Exim 4.94 #2 (Red Hat Linux)) id 1ljnVY-00GZnc-28; Thu, 20 May 2021 18:34:56 +0000 Subject: Re: [PATCH] f2fs: fix kernel-doc syntax in file header To: Aditya Srivastava , jaegeuk@kernel.org Cc: lukas.bulwahn@gmail.com, chao@kernel.org, linux-f2fs-devel@lists.sourceforge.net, linux-kernel@vger.kernel.org, linux-kernel-mentees@lists.linuxfoundation.org, linux-doc@vger.kernel.org References: <20210520182933.31965-1-yashsri421@gmail.com> From: Randy Dunlap Message-ID: Date: Thu, 20 May 2021 11:34:55 -0700 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.10.0 MIME-Version: 1.0 In-Reply-To: <20210520182933.31965-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 5/20/21 11:29 AM, Aditya Srivastava wrote: > The opening comment mark '/**' is used for highlighting the beginning of > kernel-doc comments. > The header for include/linux/f2fs_fs.h 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: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst > * include/linux/f2fs_fs.h > > 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 Even better would be to remove the filename from the file. Thanks. > --- > include/linux/f2fs_fs.h | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/include/linux/f2fs_fs.h b/include/linux/f2fs_fs.h > index 5487a80617a3..028d1b18f0e7 100644 > --- a/include/linux/f2fs_fs.h > +++ b/include/linux/f2fs_fs.h > @@ -1,5 +1,5 @@ > // SPDX-License-Identifier: GPL-2.0 > -/** > +/* > * include/linux/f2fs_fs.h > * > * Copyright (c) 2012 Samsung Electronics Co., Ltd. > -- ~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,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 B2E3AC433ED for ; Thu, 20 May 2021 19:03:52 +0000 (UTC) Received: from lists.sourceforge.net (lists.sourceforge.net [216.105.38.7]) (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 4AAFB60D07 for ; Thu, 20 May 2021 19:03:52 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 4AAFB60D07 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-f2fs-devel-bounces@lists.sourceforge.net Received: from [127.0.0.1] (helo=sfs-ml-2.v29.lw.sourceforge.com) by sfs-ml-2.v29.lw.sourceforge.com with esmtp (Exim 4.92.3) (envelope-from ) id 1ljnxW-0006Lv-Uw; Thu, 20 May 2021 19:03:50 +0000 Received: from [172.30.20.202] (helo=mx.sourceforge.net) by sfs-ml-2.v29.lw.sourceforge.com with esmtps (TLSv1.2:ECDHE-RSA-AES256-GCM-SHA384:256) (Exim 4.92.3) (envelope-from ) id 1ljnxV-0006Lo-Om for linux-f2fs-devel@lists.sourceforge.net; Thu, 20 May 2021 19:03:49 +0000 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=sourceforge.net; s=x; 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:Resent-Date:Resent-From:Resent-Sender: Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help:List-Unsubscribe: List-Subscribe:List-Post:List-Owner:List-Archive; bh=V+JOfDgV7psnkj9YIO5jH92IC9XuEYZaAjsGKe0XexU=; b=dOAlpNIj395gth8f1SZyOiJsDZ 8VDwDdmTARksxnQtiyDpL1bJH866+HW9G9jhqUXeUmP+sNBFprCePtpY5eKQrQR1k0OxjyygVlX8X oIcrn3l1mP99XLZC8mQfK2mkvTHWvRBmcTXNxUQfVbKL2aWKgZ5bDYyghDvADHiWzjZU=; DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=sf.net; s=x ; 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:Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc :Resent-Message-ID:List-Id:List-Help:List-Unsubscribe:List-Subscribe: List-Post:List-Owner:List-Archive; bh=V+JOfDgV7psnkj9YIO5jH92IC9XuEYZaAjsGKe0XexU=; b=Uf4G46O7VoXMUs3nXTACXncL2o jEJBw6mGW9sFdw4aak24c+gi3tvzgNwTCFDCqPTfzVNa9mK3f0UM2slBaIQRQtP2CBI4FdQu92XAF kXo8R7YYCwxd9AH+VDuaysK0lq0AoUjGWYKLcj6/UzEuoaGqpsDoFzroyzRCr2B//OX0=; Received: from bombadil.infradead.org ([198.137.202.133]) by sfi-mx-2.v28.lw.sourceforge.com with esmtps (TLSv1.2:ECDHE-RSA-AES256-GCM-SHA384:256) (Exim 4.92.3) id 1ljnxP-0002Nc-G5 for linux-f2fs-devel@lists.sourceforge.net; Thu, 20 May 2021 19:03:49 +0000 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; 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=V+JOfDgV7psnkj9YIO5jH92IC9XuEYZaAjsGKe0XexU=; b=xTP5O2cQQJsLksrvH79y45+Bkv V3Q2iFmUSM/LouF/+t/bmVFzQeKVSNHXIlfXo1Jr92T4rRrsQaTLADiY45CIz2GaX6gdQO6DTxHbX 0yndj/n79FqynwJupu6W4GEVL7VFRF6Xm460otL4s6Gz1J/L66YIzPRWylOMkS0PODnR1RM+t9NiT k6c6yNfsp4nAjTevHLoYByTs+MOWfIkOX62J86cagaD5m1Q3VvH5gSs3F75LDZHJX+20TAYUkDc4O g59DKwmjMI8JC+NaRRO/WTZS5HSdN34JxKrM5ob9p1lfWJbeEJLcUTi7E03hjpGvaxfljBWdZL2PJ AAzICuOg==; Received: from [2601:1c0:6280:3f0::7376] by bombadil.infradead.org with esmtpsa (Exim 4.94 #2 (Red Hat Linux)) id 1ljnVY-00GZnc-28; Thu, 20 May 2021 18:34:56 +0000 To: Aditya Srivastava , jaegeuk@kernel.org References: <20210520182933.31965-1-yashsri421@gmail.com> From: Randy Dunlap Message-ID: Date: Thu, 20 May 2021 11:34:55 -0700 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.10.0 MIME-Version: 1.0 In-Reply-To: <20210520182933.31965-1-yashsri421@gmail.com> Content-Language: en-US X-Headers-End: 1ljnxP-0002Nc-G5 Subject: Re: [f2fs-dev] [PATCH] f2fs: fix kernel-doc syntax in file header X-BeenThere: linux-f2fs-devel@lists.sourceforge.net X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, linux-f2fs-devel@lists.sourceforge.net, lukas.bulwahn@gmail.com, linux-kernel-mentees@lists.linuxfoundation.org Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: linux-f2fs-devel-bounces@lists.sourceforge.net On 5/20/21 11:29 AM, Aditya Srivastava wrote: > The opening comment mark '/**' is used for highlighting the beginning of > kernel-doc comments. > The header for include/linux/f2fs_fs.h 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: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst > * include/linux/f2fs_fs.h > > 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 Even better would be to remove the filename from the file. Thanks. > --- > include/linux/f2fs_fs.h | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/include/linux/f2fs_fs.h b/include/linux/f2fs_fs.h > index 5487a80617a3..028d1b18f0e7 100644 > --- a/include/linux/f2fs_fs.h > +++ b/include/linux/f2fs_fs.h > @@ -1,5 +1,5 @@ > // SPDX-License-Identifier: GPL-2.0 > -/** > +/* > * include/linux/f2fs_fs.h > * > * Copyright (c) 2012 Samsung Electronics Co., Ltd. > -- ~Randy _______________________________________________ Linux-f2fs-devel mailing list Linux-f2fs-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/linux-f2fs-devel 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,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 9D7B8C433B4 for ; Thu, 20 May 2021 18:35:00 +0000 (UTC) Received: from smtp1.osuosl.org (smtp1.osuosl.org [140.211.166.138]) (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 3264C610CC for ; Thu, 20 May 2021 18:35:00 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 3264C610CC 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 smtp1.osuosl.org (Postfix) with ESMTP id F106283CFE; Thu, 20 May 2021 18:34:59 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from smtp1.osuosl.org ([127.0.0.1]) by localhost (smtp1.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id FkDi-n6Y4uXf; Thu, 20 May 2021 18:34:59 +0000 (UTC) Received: from lists.linuxfoundation.org (lf-lists.osuosl.org [IPv6:2605:bc80:3010:104::8cd3:938]) by smtp1.osuosl.org (Postfix) with ESMTP id F34E183BBC; Thu, 20 May 2021 18:34:58 +0000 (UTC) Received: from lf-lists.osuosl.org (localhost [127.0.0.1]) by lists.linuxfoundation.org (Postfix) with ESMTP id C60DEC000E; Thu, 20 May 2021 18:34:58 +0000 (UTC) Received: from smtp1.osuosl.org (smtp1.osuosl.org [IPv6:2605:bc80:3010::138]) by lists.linuxfoundation.org (Postfix) with ESMTP id C7A5FC0001 for ; Thu, 20 May 2021 18:34:57 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by smtp1.osuosl.org (Postfix) with ESMTP id AAB9883CC8 for ; Thu, 20 May 2021 18:34:57 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from smtp1.osuosl.org ([127.0.0.1]) by localhost (smtp1.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id UlpPMNXjhuk7 for ; Thu, 20 May 2021 18:34:57 +0000 (UTC) X-Greylist: from auto-whitelisted by SQLgrey-1.8.0 Received: from bombadil.infradead.org (bombadil.infradead.org [IPv6:2607:7c80:54:e::133]) by smtp1.osuosl.org (Postfix) with ESMTPS id 22D9B83BBC for ; Thu, 20 May 2021 18:34:57 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; 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=V+JOfDgV7psnkj9YIO5jH92IC9XuEYZaAjsGKe0XexU=; b=xTP5O2cQQJsLksrvH79y45+Bkv V3Q2iFmUSM/LouF/+t/bmVFzQeKVSNHXIlfXo1Jr92T4rRrsQaTLADiY45CIz2GaX6gdQO6DTxHbX 0yndj/n79FqynwJupu6W4GEVL7VFRF6Xm460otL4s6Gz1J/L66YIzPRWylOMkS0PODnR1RM+t9NiT k6c6yNfsp4nAjTevHLoYByTs+MOWfIkOX62J86cagaD5m1Q3VvH5gSs3F75LDZHJX+20TAYUkDc4O g59DKwmjMI8JC+NaRRO/WTZS5HSdN34JxKrM5ob9p1lfWJbeEJLcUTi7E03hjpGvaxfljBWdZL2PJ AAzICuOg==; Received: from [2601:1c0:6280:3f0::7376] by bombadil.infradead.org with esmtpsa (Exim 4.94 #2 (Red Hat Linux)) id 1ljnVY-00GZnc-28; Thu, 20 May 2021 18:34:56 +0000 Subject: Re: [PATCH] f2fs: fix kernel-doc syntax in file header To: Aditya Srivastava , jaegeuk@kernel.org References: <20210520182933.31965-1-yashsri421@gmail.com> From: Randy Dunlap Message-ID: Date: Thu, 20 May 2021 11:34:55 -0700 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.10.0 MIME-Version: 1.0 In-Reply-To: <20210520182933.31965-1-yashsri421@gmail.com> Content-Language: en-US Cc: linux-doc@vger.kernel.org, chao@kernel.org, linux-kernel@vger.kernel.org, linux-f2fs-devel@lists.sourceforge.net, linux-kernel-mentees@lists.linuxfoundation.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 5/20/21 11:29 AM, Aditya Srivastava wrote: > The opening comment mark '/**' is used for highlighting the beginning of > kernel-doc comments. > The header for include/linux/f2fs_fs.h 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: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst > * include/linux/f2fs_fs.h > > 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 Even better would be to remove the filename from the file. Thanks. > --- > include/linux/f2fs_fs.h | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/include/linux/f2fs_fs.h b/include/linux/f2fs_fs.h > index 5487a80617a3..028d1b18f0e7 100644 > --- a/include/linux/f2fs_fs.h > +++ b/include/linux/f2fs_fs.h > @@ -1,5 +1,5 @@ > // SPDX-License-Identifier: GPL-2.0 > -/** > +/* > * include/linux/f2fs_fs.h > * > * Copyright (c) 2012 Samsung Electronics Co., Ltd. > -- ~Randy _______________________________________________ Linux-kernel-mentees mailing list Linux-kernel-mentees@lists.linuxfoundation.org https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees