Re: [PATCH -next v2] ntb: Fix kernel-doc param for ntb_transport_create_queue

From: Dave Jiang
Date: Fri Jun 07 2024 - 12:14:47 EST




On 6/7/24 12:57 AM, Yang Li wrote:
> The patch updates ntb_transport_create_queue() kdoc header to specify the
> correct input parameters used by the function.
>
> Signed-off-by: Yang Li <yang.lee@xxxxxxxxxxxxxxxxx>

Thank you!

Reviewed-by: Dave Jiang <dave.jiang@xxxxxxxxx>
> ---

I do recommend attaching the revision history below the '---' line next time for common patch posting practice. Thanks
> drivers/ntb/ntb_transport.c | 7 ++++---
> 1 file changed, 4 insertions(+), 3 deletions(-)
>
> diff --git a/drivers/ntb/ntb_transport.c b/drivers/ntb/ntb_transport.c
> index f9e7847a378e..5d466a3f117b 100644
> --- a/drivers/ntb/ntb_transport.c
> +++ b/drivers/ntb/ntb_transport.c
> @@ -1966,9 +1966,10 @@ static bool ntb_dma_filter_fn(struct dma_chan *chan, void *node)
>
> /**
> * ntb_transport_create_queue - Create a new NTB transport layer queue
> - * @rx_handler: receive callback function
> - * @tx_handler: transmit callback function
> - * @event_handler: event callback function
> + * @data: user-defined data to associate with the queue
> + * @client_dev: the device structure of the NTB client
> + * @handlers: structure containing receive, transmit, and event callback
> + * functions
> *
> * Create a new NTB transport layer queue and provide the queue with a callback
> * routine for both transmit and receive. The receive callback routine will be