2022-02-18 11:06:06

by Jiapeng Chong

[permalink] [raw]
Subject: [PATCH] btrfs: Fix non-kernel-doc comment

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 <[email protected]>
Signed-off-by: Jiapeng Chong <[email protected]>
---
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
diff --git a/fs/btrfs/extent_io.c b/fs/btrfs/extent_io.c
index d5a8064e3206..2da140200de8 100644
--- a/fs/btrfs/extent_io.c
+++ b/fs/btrfs/extent_io.c
@@ -4919,7 +4919,7 @@ int btree_write_cache_pages(struct address_space *mapping,
return ret;
}

-/**
+/*
* Walk the list of dirty pages of the given address space and write all of them.
*
* @mapping: address space structure to write
diff --git a/fs/btrfs/extent_map.c b/fs/btrfs/extent_map.c
index 6fee14ce2e6b..984f183413c2 100644
--- a/fs/btrfs/extent_map.c
+++ b/fs/btrfs/extent_map.c
@@ -386,7 +386,7 @@ static void extent_map_device_clear_bits(struct extent_map *em, unsigned bits)
}
}

-/**
+/*
* Add new extent map to the extent tree
*
* @tree: tree to insert new map in
diff --git a/fs/btrfs/file-item.c b/fs/btrfs/file-item.c
index 364bfca1cc06..96b30369fa26 100644
--- a/fs/btrfs/file-item.c
+++ b/fs/btrfs/file-item.c
@@ -621,7 +621,7 @@ int btrfs_lookup_csums_range(struct btrfs_root *root, u64 start, u64 end,
return ret;
}

-/**
+/*
* Calculate checksums of the data contained inside a bio
*
* @inode: Owner of the data inside the bio
diff --git a/fs/btrfs/inode.c b/fs/btrfs/inode.c
index 44e8d28182b7..8ccc3818eebe 100644
--- a/fs/btrfs/inode.c
+++ b/fs/btrfs/inode.c
@@ -3430,7 +3430,7 @@ void btrfs_run_delayed_iputs(struct btrfs_fs_info *fs_info)
spin_unlock(&fs_info->delayed_iput_lock);
}

-/**
+/*
* Wait for flushing all delayed iputs
*
* @fs_info: the filesystem
diff --git a/fs/btrfs/ioctl.c b/fs/btrfs/ioctl.c
index 998bf48e5ce2..c84cc2efff77 100644
--- a/fs/btrfs/ioctl.c
+++ b/fs/btrfs/ioctl.c
@@ -1785,7 +1785,7 @@ int btrfs_defrag_ioctl_args_to_ctrl(struct btrfs_fs_info *fs_info,
return 0;
}

-/**
+/*
* Entry point to file defragmentation.
*
* @inode: inode to be defragged
--
2.20.1.7.g153144c


2022-02-18 13:38:13

by David Sterba

[permalink] [raw]
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 <[email protected]>
> Signed-off-by: Jiapeng Chong <[email protected]>
> ---
> 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.