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=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 62A2DC433E0 for ; Wed, 17 Mar 2021 21:26:44 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id DC0B664DAE for ; Wed, 17 Mar 2021 21:26:43 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232088AbhCQV0L (ORCPT ); Wed, 17 Mar 2021 17:26:11 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:60482 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230171AbhCQVZt (ORCPT ); Wed, 17 Mar 2021 17:25:49 -0400 Received: from merlin.infradead.org (merlin.infradead.org [IPv6:2001:8b0:10b:1234::107]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id BCF0BC06174A; Wed, 17 Mar 2021 14:25:48 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=merlin.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=fK5+i0hUGolj7mGml8H6sgNsoTx8ktey7VXlunodqoc=; b=gyveDLk2NfrD+0kIRX7/a/8CmJ 5B+MQc2Gh+CU2p4pb0ZXka3536nmzos8MxHntbrgopxz2A+bUVQJA6PDdAcMBm7+q4dE0smSRq3Yt 1drP/x50jfEDRlVhK0NRiPqYNtkx/DhJaBg/R6U19zoN21PEjMH3de5sJH9fFkiP/GDXoDh/Fmc1c g9SUPWESptQdvmlPJdyd6XOw+H+V38lZUi+EI1siB9q/6Hfl0dADdC4CfOQkzqqGPEUEqdi2crd+6 kOhbEITb1nAj2tG8M9uy08tyK/l/46Hq6hsJ+zTPpgGfTs/HkoBtXpbDzBJDHifzwYaC84qmwyf12 oxh9gMAw==; Received: from [2601:1c0:6280:3f0::9757] by merlin.infradead.org with esmtpsa (Exim 4.94 #2 (Red Hat Linux)) id 1lMdfW-001gnN-AK; Wed, 17 Mar 2021 21:25:36 +0000 Subject: Re: [PATCH] block: fix comment syntax in file headers To: Aditya Srivastava , linux-kernel@vger.kernel.org Cc: lukas.bulwahn@gmail.com, linux-kernel-mentees@lists.linuxfoundation.org, ldm@flatcap.org, axboe@kernel.dk, linux-ntfs-dev@lists.sourceforge.net, linux-block@vger.kernel.org References: <20210317205245.24857-1-yashsri421@gmail.com> From: Randy Dunlap Message-ID: <087c2cf0-2085-be13-f6db-8ebacb22b252@infradead.org> Date: Wed, 17 Mar 2021 14:25:26 -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: <20210317205245.24857-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-block@vger.kernel.org On 3/17/21 1:52 PM, Aditya Srivastava wrote: > The opening comment mark '/**' is used for highlighting the beginning of > kernel-doc comments. > There are files in block/partitions/ which follow this syntax in their file > headers, i.e. start with '/**' like comments, which causes unexpected > warnings from kernel-doc. > > E.g., running scripts/kernel-doc -none on block/partitions/ldm.h > causes this warning: > "warning: expecting prototype for ldm(). Prototype was for _FS_PT_LDM_H_() instead" > > Provide a simple fix by replacing such occurrences with general comment > format, i.e., "/*", to prevent kernel-doc from parsing it. > > Signed-off-by: Aditya Srivastava Acked-by: Randy Dunlap Thanks. > --- > * Applies perfectly on next-20210312 > > block/partitions/ldm.c | 2 +- > block/partitions/ldm.h | 2 +- > 2 files changed, 2 insertions(+), 2 deletions(-) > > diff --git a/block/partitions/ldm.c b/block/partitions/ldm.c > index d333786b5c7e..14b124cdacfc 100644 > --- a/block/partitions/ldm.c > +++ b/block/partitions/ldm.c > @@ -1,5 +1,5 @@ > // SPDX-License-Identifier: GPL-2.0-or-later > -/** > +/* > * ldm - Support for Windows Logical Disk Manager (Dynamic Disks) > * > * Copyright (C) 2001,2002 Richard Russon > diff --git a/block/partitions/ldm.h b/block/partitions/ldm.h > index d8d6beaa72c4..ffdecf1c6bb3 100644 > --- a/block/partitions/ldm.h > +++ b/block/partitions/ldm.h > @@ -1,5 +1,5 @@ > // SPDX-License-Identifier: GPL-2.0-or-later > -/** > +/* > * ldm - Part of the Linux-NTFS project. > * > * Copyright (C) 2001,2002 Richard Russon > -- ~Randy