linux-kernel - Re: [PATCH] btrfs: Fix non-kernel-doc comment

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Date:   Fri, 18 Feb 2022 14:06:28 +0100
From:   David Sterba <dsterba@...e.cz>
To:     Jiapeng Chong <jiapeng.chong@...ux.alibaba.com>
Cc:     clm@...com, josef@...icpanda.com, dsterba@...e.com,
        linux-btrfs@...r.kernel.org, linux-kernel@...r.kernel.org,
        Abaci Robot <abaci@...ux.alibaba.com>
Subject: Re: [PATCH] btrfs: Fix non-kernel-doc comment

On Fri, Feb 18, 2022 at 06:13:45PM +0800, Jiapeng Chong wrote:
> Fixes the following W=1 kernel build warning:
> 
> fs/btrfs/ioctl.c:1789: warning: This comment starts with '/**', but
> isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Entry point to file defragmentation.
> 
> fs/btrfs/extent_map.c:390: warning: This comment starts with '/**', but
> isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Add new extent map to the extent tree.
> 
> fs/btrfs/block-group.c:1743: warning: This comment starts with '/**',
> but isn't a kernel-doc comment. Refer
> Documentation/doc-guide/kernel-doc.rst
>  * Map a physical disk address to a list of logical addresses.
> 
> fs/btrfs/extent_io.c:4923: warning: This comment starts with '/**', but
> isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Walk the list of dirty pages of the given address space and write all
>  * of them.
> 
> fs/btrfs/file-item.c:625: warning: This comment starts with '/**', but
> isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Calculate checksums of the data contained inside a bio.
> 
> fs/btrfs/inode.c:3430: warning: This comment starts with '/**', but
> isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Wait for flushing all delayed iputs
> 
> Reported-by: Abaci Robot <abaci@...ux.alibaba.com>
> Signed-off-by: Jiapeng Chong <jiapeng.chong@...ux.alibaba.com>
> ---
>  fs/btrfs/block-group.c | 2 +-
>  fs/btrfs/extent_io.c   | 2 +-
>  fs/btrfs/extent_map.c  | 2 +-
>  fs/btrfs/file-item.c   | 2 +-
>  fs/btrfs/inode.c       | 2 +-
>  fs/btrfs/ioctl.c       | 2 +-
>  6 files changed, 6 insertions(+), 6 deletions(-)
> 
> diff --git a/fs/btrfs/block-group.c b/fs/btrfs/block-group.c
> index c22d287e020b..884002e510ec 100644
> --- a/fs/btrfs/block-group.c
> +++ b/fs/btrfs/block-group.c
> @@ -1739,7 +1739,7 @@ static void set_avail_alloc_bits(struct btrfs_fs_info *fs_info, u64 flags)
>  	write_sequnlock(&fs_info->profiles_lock);
>  }
>  
> -/**
> +/*
>   * Map a physical disk address to a list of logical addresses
>   *
>   * @fs_info:       the filesystem

We'd actually like the kdoc script to check the argument list.