tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

xen/xenbus: document will_handle argument for xenbus_watch_path()

Commit 2e85d32b1c86 ("xen/xenbus: Add 'will_handle' callback support in
xenbus_watch_path()") added will_handle argument to xenbus_watch_path()
and its wrapper, xenbus_watch_pathfmt(), but didn't document it on the
kerneldoc comments of the function. This is causing warnings that
reported by kernel test robot. Add the documentation to fix it.

Fixes: 2e85d32b1c86 ("xen/xenbus: Add 'will_handle' callback support in xenbus_watch_path()")
Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202401121154.FI8jDGun-lkp@intel.com/
Signed-off-by: SeongJae Park <sj@kernel.org>
Reviewed-by: Juergen Gross <jgross@suse.com>
Link: https://lore.kernel.org/r/20240112185903.83737-1-sj@kernel.org
Signed-off-by: Juergen Gross <jgross@suse.com>

authored by

SeongJae Park and committed by
Juergen Gross 7d8c67dd 841c3516

+9 -6
+9 -6
drivers/xen/xenbus/xenbus_client.c
··· 116 116 * @dev: xenbus device 117 117 * @path: path to watch 118 118 * @watch: watch to register 119 + * @will_handle: events queuing determine callback 119 120 * @callback: callback to register 120 121 * 121 122 * Register a @watch on the given path, using the given xenbus_watch structure 122 - * for storage, and the given @callback function as the callback. On success, 123 - * the given @path will be saved as @watch->node, and remains the 124 - * caller's to free. On error, @watch->node will 125 - * be NULL, the device will switch to %XenbusStateClosing, and the error will 126 - * be saved in the store. 123 + * for storage, @will_handle function as the callback to determine if each 124 + * event need to be queued, and the given @callback function as the callback. 125 + * On success, the given @path will be saved as @watch->node, and remains the 126 + * caller's to free. On error, @watch->node will be NULL, the device will 127 + * switch to %XenbusStateClosing, and the error will be saved in the store. 127 128 * 128 129 * Returns: %0 on success or -errno on error 129 130 */ ··· 159 158 * xenbus_watch_pathfmt - register a watch on a sprintf-formatted path 160 159 * @dev: xenbus device 161 160 * @watch: watch to register 161 + * @will_handle: events queuing determine callback 162 162 * @callback: callback to register 163 163 * @pathfmt: format of path to watch 164 164 * 165 165 * Register a watch on the given @path, using the given xenbus_watch 166 - * structure for storage, and the given @callback function as the 166 + * structure for storage, @will_handle function as the callback to determine if 167 + * each event need to be queued, and the given @callback function as the 167 168 * callback. On success, the watched path (@path/@path2) will be saved 168 169 * as @watch->node, and becomes the caller's to kfree(). 169 170 * On error, watch->node will be NULL, so the caller has nothing to