2021-03-17 20:54:23

by Aditya Srivastava

Subject: [PATCH] block: fix comment syntax in file headers

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 <[email protected]>
---
* 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 <[email protected]>
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 <[email protected]>
--
2.17.1

2021-03-17 21:49:33

by Randy Dunlap

Subject: Re: [PATCH] block: fix comment syntax in file headers

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 <[email protected]>

Acked-by: Randy Dunlap <[email protected]>

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 <[email protected]>
> 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 <[email protected]>
>


--
~Randy