[PATCH -next] NTFS: Fix one kernel-doc comment

[PATCH -next] NTFS: Fix one kernel-doc comment

[Yang Li]

/**
 * attrib.c - NTFS attribute operations.  Part of the Linux-NTFS

The comments for the file should not be in kernel-doc format, which causes
it to be incorrectly identified for function ntfs_map_runlist_nolock(),
causing some warnings found by running scripts/kernel-doc.

fs/ntfs/attrib.c:25: warning: Incorrect use of kernel-doc format:  *
ntfs_map_runlist_nolock - map (a part of) a runlist of an ntfs inode
fs/ntfs/attrib.c:71: warning: Function parameter or member 'ni' not
described in 'ntfs_map_runlist_nolock'
fs/ntfs/attrib.c:71: warning: Function parameter or member 'vcn' not
described in 'ntfs_map_runlist_nolock'
fs/ntfs/attrib.c:71: warning: Function parameter or member 'ctx' not
described in 'ntfs_map_runlist_nolock'
fs/ntfs/attrib.c:71: warning: expecting prototype for attrib.c - NTFS
attribute operations.  Part of the Linux(). Prototype was for
ntfs_map_runlist_nolock() instead

Reported-by: Abaci Robot <abaci@linux.alibaba.com>
Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
---
 fs/ntfs/attrib.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/fs/ntfs/attrib.c b/fs/ntfs/attrib.c
index d563abc3e136..2911c04a33e0 100644
--- a/fs/ntfs/attrib.c
+++ b/fs/ntfs/attrib.c
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
-/**
+/*
  * attrib.c - NTFS attribute operations.  Part of the Linux-NTFS project.
  *
  * Copyright (c) 2001-2012 Anton Altaparmakov and Tuxera Inc.
-- 
2.20.1.7.g153144c

Re: [PATCH -next] NTFS: Fix one kernel-doc comment

[Randy Dunlap]

On 1/5/22 17:51, Yang Li wrote:
> /**
>  * attrib.c - NTFS attribute operations.  Part of the Linux-NTFS
> 
> The comments for the file should not be in kernel-doc format, which causes
> it to be incorrectly identified for function ntfs_map_runlist_nolock(),
> causing some warnings found by running scripts/kernel-doc.
> 
> fs/ntfs/attrib.c:25: warning: Incorrect use of kernel-doc format:  *
> ntfs_map_runlist_nolock - map (a part of) a runlist of an ntfs inode
> fs/ntfs/attrib.c:71: warning: Function parameter or member 'ni' not
> described in 'ntfs_map_runlist_nolock'
> fs/ntfs/attrib.c:71: warning: Function parameter or member 'vcn' not
> described in 'ntfs_map_runlist_nolock'
> fs/ntfs/attrib.c:71: warning: Function parameter or member 'ctx' not
> described in 'ntfs_map_runlist_nolock'
> fs/ntfs/attrib.c:71: warning: expecting prototype for attrib.c - NTFS
> attribute operations.  Part of the Linux(). Prototype was for
> ntfs_map_runlist_nolock() instead
> 
> Reported-by: Abaci Robot <abaci@linux.alibaba.com>
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>

Acked-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

[adding akpm]

> ---
>  fs/ntfs/attrib.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/fs/ntfs/attrib.c b/fs/ntfs/attrib.c
> index d563abc3e136..2911c04a33e0 100644
> --- a/fs/ntfs/attrib.c
> +++ b/fs/ntfs/attrib.c
> @@ -1,5 +1,5 @@
>  // SPDX-License-Identifier: GPL-2.0-or-later
> -/**
> +/*
>   * attrib.c - NTFS attribute operations.  Part of the Linux-NTFS project.
>   *
>   * Copyright (c) 2001-2012 Anton Altaparmakov and Tuxera Inc.

-- 
~Randy