xen/xenbus: document will_handle argument for xenbus_watch_path()
PATCH 1/1 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.
--- drivers/xen/xenbus/xenbus_client.c | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-)
drivers/xen/xenbus/xenbus_client.c +15 -11
@@ -116,14 +116,16 @@ EXPORT_SYMBOL_GPL(xenbus_strstate);* @dev: xenbus device * @path: path to watch * @watch: watch to register +* @will_handle: events queuing determine callback * @callback: callback to register * * Register a @watch on the given path, using the given xenbus_watch structure -* for storage, and the given @callback function as the callback. Return 0 on -* success, or -errno on error. On success, the given @path will be saved as -* @watch->node, and remains the caller's to free. On error, @watch->node will -* be NULL, the device will switch to %XenbusStateClosing, and the error will -* be saved in the store. +* for storage, @will_handle function as the callback to determine if each +* event need to be queued, and the given @callback function as the callback. +* Return 0 on success, or -errno on error. On success, the given @path will +* be saved as @watch->node, and remains the caller's to free. On error, +* @watch->node will be NULL, the device will switch to %XenbusStateClosing, +* and the error will be saved in the store. */ int xenbus_watch_path(struct xenbus_device *dev, const char *path, struct xenbus_watch *watch,
@@ -156,16 +158,18 @@ EXPORT_SYMBOL_GPL(xenbus_watch_path);* xenbus_watch_pathfmt - register a watch on a sprintf-formatted path * @dev: xenbus device * @watch: watch to register +* @will_handle: events queuing determine callback * @callback: callback to register * @pathfmt: format of path to watch * * Register a watch on the given @path, using the given xenbus_watch -* structure for storage, and the given @callback function as the callback. -* Return 0 on success, or -errno on error. On success, the watched path -* (@path/@path2) will be saved as @watch->node, and becomes the caller's to -* kfree(). On error, watch->node will be NULL, so the caller has nothing to -* free, the device will switch to %XenbusStateClosing, and the error will be -* saved in the store. +* structure for storage, @will_handle function as the callback to determine if +* each event need to be queued, and the given @callback function as the +* callback. Return 0 on success, or -errno on error. On success, the watched +* path (@path/@path2) will be saved as @watch->node, and becomes the caller's +* to kfree(). On error, watch->node will be NULL, so the caller has nothing +* to free, the device will switch to %XenbusStateClosing, and the error will +* be saved in the store. */ int xenbus_watch_pathfmt(struct xenbus_device *dev, struct xenbus_watch *watch,
Signature · 1 line
2.39.2
Quoted 10 lines · SeongJae Park
Commit
2e85d32b1c86("xen/xenbus: Add 'will_handle' callback support inxenbus_watch_path()") addedwill_handleargument toxenbus_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 <[email protected]>Signed-off-by SeongJae Park <[email protected]>
Juergen