diff mbox series

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

Message ID 20220416081534.28729-1-bagasdotme@gmail.com (mailing list archive)
State New, archived
Headers show
Series btrfs: zstd: add missing function name in zstd_reclaim_timer_fn() comment | expand

Commit Message

Bagas Sanjaya April 16, 2022, 8:15 a.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 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@intel.com/
Fixes: b672526e2ee935 (btrfs: use non-bh spin_lock in zstd timer callback)
Reported-by: kernel test robot <lkp@intel.com>
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>
---
 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(-)


base-commit: 550a34e972578538fd0826916ae4fc407b62bb68

Comments

Matthew Wilcox (Oracle) April 17, 2022, 3:16 a.m. UTC | #1 
On Sat, Apr 16, 2022 at 03:15:34PM +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

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.
Bagas Sanjaya April 17, 2022, 5:14 a.m. UTC | #2 
On 4/17/22 10:16, Matthew Wilcox wrote:
> On Sat, Apr 16, 2022 at 03:15:34PM +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
> 
> 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.
diff mbox series

Patch

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
  *