From: Randy Dunlap <rdunlap@infradead.org>
To: Aditya Srivastava <yashsri421@gmail.com>, 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
Subject: Re: [PATCH] block: fix comment syntax in file headers
Date: Wed, 17 Mar 2021 14:25:26 -0700 [thread overview]
Message-ID: <087c2cf0-2085-be13-f6db-8ebacb22b252@infradead.org> (raw)
In-Reply-To: <20210317205245.24857-1-yashsri421@gmail.com>
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 <yashsri421@gmail.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
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 <ldm@flatcap.org>
> 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 <ldm@flatcap.org>
>
--
~Randy
prev parent reply other threads:[~2021-03-17 21:26 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-03-17 20:52 [PATCH] block: fix comment syntax in file headers Aditya Srivastava
2021-03-17 21:25 ` Randy Dunlap [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=087c2cf0-2085-be13-f6db-8ebacb22b252@infradead.org \
--to=rdunlap@infradead.org \
--cc=axboe@kernel.dk \
--cc=ldm@flatcap.org \
--cc=linux-block@vger.kernel.org \
--cc=linux-kernel-mentees@lists.linuxfoundation.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-ntfs-dev@lists.sourceforge.net \
--cc=lukas.bulwahn@gmail.com \
--cc=yashsri421@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).