Skip to content

Commit f407048

Browse files
rddunlapjonmason
authored andcommitted
NTB: ntb_transport: fix all kernel-doc warnings
Fix all kernel-doc warnings in ntb_transport.c. The function parameters for ntb_transport_create_queue() changed, so update them in the kernel-doc comments. Add a Returns: comment for ntb_transport_register_client_dev(). ntb_transport.c:382: warning: No description found for return value of 'ntb_transport_register_client_dev' ntb_transport.c:1984: warning: Excess function parameter 'rx_handler' description in 'ntb_transport_create_queue' ntb_transport.c:1984: warning: Excess function parameter 'tx_handler' description in 'ntb_transport_create_queue' ntb_transport.c:1984: warning: Excess function parameter 'event_handler' description in 'ntb_transport_create_queue' Signed-off-by: Randy Dunlap <[email protected]> Cc: Jon Mason <[email protected]> Cc: Dave Jiang <[email protected]> Cc: Allen Hubbe <[email protected]> Cc: [email protected] Reviewed-by: Dave Jiang <[email protected]> Signed-off-by: Jon Mason <[email protected]>
1 parent 35c87cb commit f407048

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

drivers/ntb/ntb_transport.c

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -377,6 +377,8 @@ EXPORT_SYMBOL_GPL(ntb_transport_unregister_client_dev);
377377
* @device_name: Name of NTB client device
378378
*
379379
* Register an NTB client device with the NTB transport layer
380+
*
381+
* Returns: %0 on success or -errno code on error
380382
*/
381383
int ntb_transport_register_client_dev(char *device_name)
382384
{
@@ -1966,9 +1968,9 @@ static bool ntb_dma_filter_fn(struct dma_chan *chan, void *node)
19661968

19671969
/**
19681970
* ntb_transport_create_queue - Create a new NTB transport layer queue
1969-
* @rx_handler: receive callback function
1970-
* @tx_handler: transmit callback function
1971-
* @event_handler: event callback function
1971+
* @data: pointer for callback data
1972+
* @client_dev: &struct device pointer
1973+
* @handlers: pointer to various ntb queue (callback) handlers
19721974
*
19731975
* Create a new NTB transport layer queue and provide the queue with a callback
19741976
* routine for both transmit and receive. The receive callback routine will be

0 commit comments

Comments
 (0)