diff mbox series

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

Message ID 20220418125934.566647-1-bagasdotme@gmail.com (mailing list archive)
State New, archived
Headers show
Series btrfs: zstd: remove extraneous asterix at the head of zstd_reclaim_timer_fn() comment | expand

Commit Message

Bagas Sanjaya April 18, 2022, 12:59 p.m. UTC 
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 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.

Link: https://lore.kernel.org/linux-doc/202204151934.CkKcnvuJ-lkp@intel.com/
Fixes: b672526e2ee935 ("btrfs: use non-bh spin_lock in zstd timer callback")
Cc: Chris Mason <clm@fb.com>
Cc: Josef Bacik <josef@toxicpanda.com>
Cc: David Sterba <dsterba@suse.com>
Cc: Nick Terrell <terrelln@fb.com>
Cc: Schspa Shi <schspa@gmail.com>
Cc: linux-btrfs@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 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/YluGmERvtQY9ju7Y@casper.infradead.org/

 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(-)


base-commit: 550a34e972578538fd0826916ae4fc407b62bb68

Comments

Josef Bacik April 18, 2022, 3:29 p.m. UTC | #1 
On Mon, Apr 18, 2022 at 07:59:35PM +0700, Bagas Sanjaya wrote:
> 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 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.
> 
> Link: https://lore.kernel.org/linux-doc/202204151934.CkKcnvuJ-lkp@intel.com/
> Fixes: b672526e2ee935 ("btrfs: use non-bh spin_lock in zstd timer callback")
> Cc: Chris Mason <clm@fb.com>
> Cc: Josef Bacik <josef@toxicpanda.com>
> Cc: David Sterba <dsterba@suse.com>
> Cc: Nick Terrell <terrelln@fb.com>
> Cc: Schspa Shi <schspa@gmail.com>
> Cc: linux-btrfs@vger.kernel.org
> Cc: linux-kernel@vger.kernel.org
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>

Reviewed-by: Josef Bacik <josef@toxicpanda.com>

Thanks,

Josef
Bagas Sanjaya April 19, 2022, 5:19 a.m. UTC | #2 
On 4/18/22 22:29, Josef Bacik wrote:
> Reviewed-by: Josef Bacik <josef@toxicpanda.com>
> 
> Thanks,
> 
> Josef

Thanks for the review. Should I send v2 with your Reviewed-by
tag?
David Sterba April 19, 2022, 1:06 p.m. UTC | #3 
On Tue, Apr 19, 2022 at 12:19:44PM +0700, Bagas Sanjaya wrote:
> On 4/18/22 22:29, Josef Bacik wrote:
> > Reviewed-by: Josef Bacik <josef@toxicpanda.com>
> > 
> > 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.
diff mbox series

Patch

diff --git a/fs/btrfs/zstd.c b/fs/btrfs/zstd.c
index 0fe31a6f6e68f0..ca2102a46faefd 100644
--- a/fs/btrfs/zstd.c
+++ b/fs/btrfs/zstd.c
@@ -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