fs/btrfs/zstd.c:98: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

From: kernel test robot
Date: Wed Aug 03 2022 - 12:58:32 EST


tree: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git master
head: e2b542100719a93f8cdf6d90185410d38a57a4c1
commit: dd7382a2a7da91a475703810a87a80d6eae14645 btrfs: use non-bh spin_lock in zstd timer callback
date: 3 months ago
config: hexagon-randconfig-r002-20220803 (https://download.01.org/0day-ci/archive/20220804/202208040057.KEoGGTvs-lkp@xxxxxxxxx/config)
compiler: clang version 16.0.0 (https://github.com/llvm/llvm-project 495519e5f8232d144ed26e9c18dbcbac6a5f25eb)
reproduce (this is a W=1 build):
wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross
chmod +x ~/bin/make.cross
# https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=dd7382a2a7da91a475703810a87a80d6eae14645
git remote add linus https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
git fetch --no-tags linus master
git checkout dd7382a2a7da91a475703810a87a80d6eae14645
# save the config file
mkdir build_dir && cp config build_dir/.config
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=clang make.cross W=1 O=build_dir ARCH=hexagon SHELL=/bin/bash fs/btrfs/

If you fix the issue, kindly add following tag where applicable
Reported-by: kernel test robot <lkp@xxxxxxxxx>

All warnings (new ones prefixed by >>):

>> fs/btrfs/zstd.c:98: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* Timer callback to free unused workspaces.


vim +98 fs/btrfs/zstd.c

96
97 /**
> 98 * Timer callback to free unused workspaces.
99 *
100 * @t: timer
101 *
102 * This scans the lru_list and attempts to reclaim any workspace that hasn't
103 * been used for ZSTD_BTRFS_RECLAIM_JIFFIES.
104 *
105 * The context is softirq and does not need the _bh locking primitives.
106 */
107 static void zstd_reclaim_timer_fn(struct timer_list *timer)
108 {
109 unsigned long reclaim_threshold = jiffies - ZSTD_BTRFS_RECLAIM_JIFFIES;
110 struct list_head *pos, *next;
111
112 spin_lock(&wsm.lock);
113
114 if (list_empty(&wsm.lru_list)) {
115 spin_unlock(&wsm.lock);
116 return;
117 }
118
119 list_for_each_prev_safe(pos, next, &wsm.lru_list) {
120 struct workspace *victim = container_of(pos, struct workspace,
121 lru_list);
122 unsigned int level;
123
124 if (time_after(victim->last_used, reclaim_threshold))
125 break;
126
127 /* workspace is in use */
128 if (victim->req_level)
129 continue;
130
131 level = victim->level;
132 list_del(&victim->lru_list);
133 list_del(&victim->list);
134 zstd_free_workspace(&victim->list);
135
136 if (list_empty(&wsm.idle_ws[level - 1]))
137 clear_bit(level - 1, &wsm.active_map);
138
139 }
140
141 if (!list_empty(&wsm.lru_list))
142 mod_timer(&wsm.timer, jiffies + ZSTD_BTRFS_RECLAIM_JIFFIES);
143
144 spin_unlock(&wsm.lock);
145 }
146

--
0-DAY CI Kernel Test Service
https://01.org/lkp