[PATCH] proc: Fix W=1 build kernel-doc warning

[PATCH] proc: Fix W=1 build kernel-doc warning

[Thorsten Blum]

Building the kernel with W=1 generates the following warning:

  fs/proc/fd.c:81: warning: This comment starts with '/**',
                   but isn't a kernel-doc comment.

Use a normal comment for the helper function proc_fdinfo_permission().

Signed-off-by: Thorsten Blum <thorsten.blum@linux.dev>
---
 fs/proc/fd.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/fs/proc/fd.c b/fs/proc/fd.c
index 1f54a54bfb91..5e391cbca7a3 100644
--- a/fs/proc/fd.c
+++ b/fs/proc/fd.c
@@ -77,7 +77,7 @@ static int seq_fdinfo_open(struct inode *inode, struct file *file)
 	return single_open(file, seq_show, inode);
 }
 
-/**
+/*
  * Shared /proc/pid/fdinfo and /proc/pid/fdinfo/fd permission helper to ensure
  * that the current task has PTRACE_MODE_READ in addition to the normal
  * POSIX-like checks.
-- 
2.47.0

Re: [PATCH] proc: Fix W=1 build kernel-doc warning

[Christian Brauner]

On Fri, 18 Oct 2024 12:27:03 +0200, Thorsten Blum wrote:
> Building the kernel with W=1 generates the following warning:
> 
>   fs/proc/fd.c:81: warning: This comment starts with '/**',
>                    but isn't a kernel-doc comment.
> 
> Use a normal comment for the helper function proc_fdinfo_permission().
> 
> [...]

Applied to the vfs.fixes branch of the vfs/vfs.git tree.
Patches in the vfs.fixes branch should appear in linux-next soon.

Please report any outstanding bugs that were missed during review in a
new review to the original patch series allowing us to drop it.

It's encouraged to provide Acked-bys and Reviewed-bys even though the
patch has now been applied. If possible patch trailers will be updated.

Note that commit hashes shown below are subject to change due to rebase,
trailer updates or similar. If in doubt, please check the listed branch.

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/vfs/vfs.git
branch: vfs.fixes

[1/1] proc: Fix W=1 build kernel-doc warning
      https://git.kernel.org/vfs/vfs/c/197231da7f6a