Skip to contentSkip to conversation

btrfs: zstd: remove extraneous asterix at the head of zstd_reclaim_timer_fn() comment

PATCH In review Bagas Sanjaya 3 participants 4 messages Apr 18, 2022 – Apr 19, 2022

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

PATCH 1/1 btrfs: zstd: remove extraneous asterix at the head of 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 comment is for zstd_reclaim_timer_fn(). Since the function is static, the comment isn't meant for kernel-doc consumption.

Remove the extraneous (second) asterix at the head of function comment.

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]>

---
In the previous fix attempt [1], Matthew Wilcox suggested to remove the second asterix instead since the function is static and it shouldn't have kernel-doc comments.

[1]: https://lore.kernel.org/linux-doc/[email protected]/

This patch is based on btrfs-devel/misc-next tree [2].

[2]: 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..ca2102a46faefd 100644
@@ -94,7 +94,7 @@ static inline struct workspace *list_to_workspace(struct list_head *list)
 void zstd_free_workspace(struct list_head *ws);
 struct list_head *zstd_alloc_workspace(unsigned int level);
 
-/**
+/*
  * Timer callback to free unused workspaces.
  *
  * @t: timer

base-commit: 550a34e972578538fd0826916ae4fc407b62bb68

Signature · 1 line
An old man doll... just what I always wanted! - Clara
Reviewed-by on v1 1/1
#1 lore raw
Quoted 9 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

The comment is for zstd_reclaim_timer_fn(). Since the function is static, the comment isn't meant for kernel-doc consumption.

Remove the extraneous (second) asterix at the head of function comment.

Quoted 10 lines
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]>

Thanks,

Josef

#2 lore raw
Quoted 5 lines · Josef Bacik

Thanks,

Josef

Thanks for the review. Should I send v2 with your Reviewed-by tag?

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

Thanks,

Josef

Thanks for the review. Should I send v2 with your Reviewed-by tag?

No, and please don't send fixes for the kdoc formats, the script does not have the same preferences as we who actually have to read the code. The kdoc format is convenient for more thnigs than just generating public documentation.