Skip to content

Commit 7d8c67d

Browse files
sjp38jgross1
authored andcommitted
xen/xenbus: document will_handle argument for xenbus_watch_path()
Commit 2e85d32 ("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: 2e85d32 ("xen/xenbus: Add 'will_handle' callback support in xenbus_watch_path()") Reported-by: kernel test robot <[email protected]> Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/ Signed-off-by: SeongJae Park <[email protected]> Reviewed-by: Juergen Gross <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Juergen Gross <[email protected]>
1 parent 841c351 commit 7d8c67d

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

drivers/xen/xenbus/xenbus_client.c

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -116,14 +116,15 @@ EXPORT_SYMBOL_GPL(xenbus_strstate);
116116
* @dev: xenbus device
117117
* @path: path to watch
118118
* @watch: watch to register
119+
* @will_handle: events queuing determine callback
119120
* @callback: callback to register
120121
*
121122
* 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.
127128
*
128129
* Returns: %0 on success or -errno on error
129130
*/
@@ -158,11 +159,13 @@ EXPORT_SYMBOL_GPL(xenbus_watch_path);
158159
* xenbus_watch_pathfmt - register a watch on a sprintf-formatted path
159160
* @dev: xenbus device
160161
* @watch: watch to register
162+
* @will_handle: events queuing determine callback
161163
* @callback: callback to register
162164
* @pathfmt: format of path to watch
163165
*
164166
* Register a watch on the given @path, using the given xenbus_watch
165-
* structure for storage, and the given @callback function as the
167+
* structure for storage, @will_handle function as the callback to determine if
168+
* each event need to be queued, and the given @callback function as the
166169
* callback. On success, the watched path (@path/@path2) will be saved
167170
* as @watch->node, and becomes the caller's to kfree().
168171
* On error, watch->node will be NULL, so the caller has nothing to

0 commit comments

Comments
 (0)