[PATCH] btrfs: zstd: add missing function name in zstd_reclaim_timer_fn() comment

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



kernel test robot reports kernel-doc warning:

>> fs/btrfs/zstd.c:98: warning: This comment starts with '/**', but
isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

The warning is caused by missing function name (in this case
zstd_reclaim_timer_fn) in the comment.

Add the function name.

Link: https://lore.kernel.org/linux-doc/202204151934.CkKcnvuJ-lkp@xxxxxxxxx/
Fixes: b672526e2ee935 (btrfs: use non-bh spin_lock in zstd timer callback)
Reported-by: kernel test robot <lkp@xxxxxxxxx>
Cc: Chris Mason <clm@xxxxxx>
Cc: Josef Bacik <josef@xxxxxxxxxxxxxx>
Cc: David Sterba <dsterba@xxxxxxxx>
Cc: Nick Terrell <terrelln@xxxxxx>
Cc: Schspa Shi <schspa@xxxxxxxxx>
Cc: linux-btrfs@xxxxxxxxxxxxxxx
Cc: linux-kernel@xxxxxxxxxxxxxxx
Signed-off-by: Bagas Sanjaya <bagasdotme@xxxxxxxxx>
---
 This patch is applied on top of btrfs-devel/misc-next [1] tree.

 [1]: https://github.com/kdave/btrfs-devel.git

 fs/btrfs/zstd.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/fs/btrfs/zstd.c b/fs/btrfs/zstd.c
index 0fe31a6f6e68f0..b2740358e94819 100644
--- a/fs/btrfs/zstd.c
+++ b/fs/btrfs/zstd.c
@@ -95,7 +95,7 @@ void zstd_free_workspace(struct list_head *ws);
 struct list_head *zstd_alloc_workspace(unsigned int level);
 
 /**
- * Timer callback to free unused workspaces.
+ * zstd_reclaim_timer_fn() - Timer callback to free unused workspaces.
  *
  * @t: timer
  *

base-commit: 550a34e972578538fd0826916ae4fc407b62bb68
-- 
An old man doll... just what I always wanted! - Clara




[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux