lists.openwall.net   lists  /  announce  owl-users  owl-dev  john-users  john-dev  passwdqc-users  yescrypt  popa3d-users  /  oss-security  kernel-hardening  musl  sabotage  tlsify  passwords  /  crypt-dev  xvendor  /  Bugtraq  Full-Disclosure  linux-kernel  linux-netdev  linux-ext4  linux-hardening  linux-cve-announce  PHC 
Open Source and information security mailing list archives
 
Hash Suite: Windows password security audit tool. GUI, reports in PDF.
[<prev] [next>] [thread-next>] [day] [month] [year] [list]
Message-Id: <20220416081534.28729-1-bagasdotme@gmail.com>
Date:   Sat, 16 Apr 2022 15:15:34 +0700
From:   Bagas Sanjaya <bagasdotme@...il.com>
To:     linux-doc@...r.kernel.org
Cc:     Bagas Sanjaya <bagasdotme@...il.com>,
        kernel test robot <lkp@...el.com>, Chris Mason <clm@...com>,
        Josef Bacik <josef@...icpanda.com>,
        David Sterba <dsterba@...e.com>,
        Nick Terrell <terrelln@...com>, Schspa Shi <schspa@...il.com>,
        linux-btrfs@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: [PATCH] btrfs: zstd: add missing function name in zstd_reclaim_timer_fn() comment

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@...el.com>
Cc: Chris Mason <clm@...com>
Cc: Josef Bacik <josef@...icpanda.com>
Cc: David Sterba <dsterba@...e.com>
Cc: Nick Terrell <terrelln@...com>
Cc: Schspa Shi <schspa@...il.com>
Cc: linux-btrfs@...r.kernel.org
Cc: linux-kernel@...r.kernel.org
Signed-off-by: Bagas Sanjaya <bagasdotme@...il.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(-)

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

Powered by blists - more mailing lists

Powered by Openwall GNU/*/Linux Powered by OpenVZ