Skip to contentSkip to conversation

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

PATCH In review Bagas Sanjaya 2 participants 3 messages Apr 16, 2022 – Apr 17, 2022

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 btrfs: zstd: add missing function name in zstd_reclaim_timer_fn() comment

kernel test robot reports kernel-doc warning:

Quoted 1 line
Quoted 1 line

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.

Fixes b672526e2ee935 (btrfs: use non-bh spin_lock in zstd timer callback)
Cc Chris Mason <[email protected]>
Cc Josef Bacik <[email protected]>
Cc David Sterba <[email protected]>
Cc Nick Terrell <[email protected]>
Cc Schspa Shi <[email protected]>

---
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(-)
fs/btrfs/zstd.c +1 -1
index 0fe31a6f6e68f0..b2740358e94819 100644
@@ -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

Signature · 1 line
An old man doll... just what I always wanted! - Clara
#1 lore raw
Quoted 4 lines · Bagas Sanjaya

kernel test robot reports kernel-doc warning:

Quoted 1 line
Quoted 1 line

fs/btrfs/zstd.c:98: warning: This comment starts with '/**', but

isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

This is the wrong fix. Static functions should not have kernel-doc comments. Just delete the second '*' at the head of the comment.

Also, btrfs developers should be testing with W=1. That will catch these problems before the code is integrated.

#2 lore raw
Quoted 11 lines · Matthew Wilcox
Quoted 4 lines · Bagas Sanjaya

kernel test robot reports kernel-doc warning:

Quoted 1 line
Quoted 1 line

fs/btrfs/zstd.c:98: warning: This comment starts with '/**', but

isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

This is the wrong fix. Static functions should not have kernel-doc comments. Just delete the second '*' at the head of the comment.

Also, btrfs developers should be testing with W=1. That will catch these problems before the code is integrated.

Oops, thanks for reminding me.

Signature · 1 line
An old man doll... just what I always wanted! - Clara