Received-SPF: pass (google.com: domain of linux-kernel+bounces-31316-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:40f1:3f00::1 as permitted sender) client-ip=2604:1380:40f1:3f00::1;
Message-ID: <ec24f943-012f-434f-8313-9c2b4e2d72e3@intel.com>
Date: Fri, 19 Jan 2024 08:36:06 -0700
User-Agent: Betterbird (Linux)
Subject: Re: [PATCH] NTB: ntb_transport: fix all kernel-doc warnings
To: Randy Dunlap <rdunlap@infradead.org>, <linux-kernel@vger.kernel.org>
CC: Jon Mason <jdmason@kudzu.us>, Allen Hubbe <allenbh@gmail.com>,
	<ntb@lists.linux.dev>
References: <20240119032845.4065-1-rdunlap@infradead.org>
Content-Language: en-US
From: Dave Jiang <dave.jiang@intel.com>
In-Reply-To: <20240119032845.4065-1-rdunlap@infradead.org>
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: 7bit
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?eW0xQjVwc1d0NGR5MGM1VWkwU3NCRnp5YjcyK3NTeWFPcUxpbEpHbXVNOEhQ?=
 =?utf-8?B?UnlwcXlUTmxNUU5SWVl0RjNzWkpnL0krNzFsanZycmRnbDJRazJyeEx1d1JU?=
 =?utf-8?B?VWsyYmlTa0JBbDZFUW5LWGlIUlVTaGUrM0YzSjdOMEJDR2xoUWZCZk42YWVi?=
 =?utf-8?B?UlYxcUlUUW5pTUx1d0ZxaHY5emxrenk0QVFZWVJSZ2lFZUtjWnpBcjZvc3Jo?=
 =?utf-8?B?WnZZa0NkaTVyMG5kT0Q4czFtL0Uvek9WZ0JJRzYxMnREaFdtWXBodS93WWMr?=
 =?utf-8?B?czRVRjRKZGRGT2ROZzdSVmZ2bVl3TzF1S1UvaWNUOTJpVEUxUmxVMFNFVkN3?=
 =?utf-8?B?L01QWU5zcFhHdHA0ZTVQRktHZHdmV2FmSTZ0L3RmekFHa1Avc3NJd2ZtOHRN?=
 =?utf-8?B?RVBrTk1ha1pkZHZsV2ZYUi8zMlkweWN3UWRsb3RzeDdVRURjNkN0cS9QcytF?=
 =?utf-8?B?VFlNTUZEUXlITlQwbXdrc3EvWUc2QzVRWnNNTTdQWHJ0NDV1Q2RjUFlrRWpN?=
 =?utf-8?B?WnJRWklpV0x4dzNIN1d6Ykg0TmFzc1V3Q1dlWDBaTm1PVnBhL3pmS0NXQTVy?=
 =?utf-8?B?R29ubVFsU1NYc1pVREpGaUI0a05IT1dmUXY4NDJ4VTJFWERRaWtsaGliRzkw?=
 =?utf-8?B?dzNxblRGMUlBWHZ1M1d0ekNNK0owM2l1K28zNjNoRTlucTh3NS9Sa2NIcDNO?=
 =?utf-8?B?MTFOdmJRTjAzd1F5dUtiMWZNVGhja1YrdVNPclNCVDM0enlwQmJnejdwcTQ2?=
 =?utf-8?B?OWEyWjlUbHc1dTZUVDN3WS9BQzMxVzFMVlY2c0tzZTJLb1hleWd5Yk1UaVN4?=
 =?utf-8?B?QjNkVFBSSlhrTW5USmhjYVkwUTg0MUZkbmhkYkdzSVZpbi9BcEZFRlJpTzg2?=
 =?utf-8?B?SndjVG1PWWVPLzRJaDdGUHBDNXM0WXhtdFA0QkprcnNWZWlFNGpERDRlSUhP?=
 =?utf-8?B?VTI4TWtMUFpkWkFkbHgwSUpzRHVHL1gwaGxSN3d6ZVhMVkJ4b2VQam50OU9O?=
 =?utf-8?B?SnFQQTVHT2QvSTNFQS92c2dGWmNqTkJ1anYySTd6enR2NTUrT3hkcFJsVXND?=
 =?utf-8?B?Vm5XT3hQTnBTWHI4QzFKQTUvSS9rcUx3eWNvdUxOczNHOXZQYUpwN3dCK0lh?=
 =?utf-8?B?akRBQVpaWHdHSEhucm40TWFBMmpaUEc2eHhIdWtQMVhaUnNNUFpxMG9pS3Vn?=
 =?utf-8?B?TWpDOUp3dlFTUVZwU2tUMW8vWnZOM2o0MU8rRlRSYmU2UVoyY1hTQnhUa01h?=
 =?utf-8?B?VXlyRVFyZ3AwYnE1TncweE9HYW5RQWx3Z1NpTEZneHRBN3l6NElRcFVPQXRt?=
 =?utf-8?B?TkJ5ck9FcmR5NXREMFBNZndvcjlzN0kwcUE2aHhHaWZ2NHBiQy9uZ3JDaEtn?=
 =?utf-8?B?MmtmNDd1TVQ4SVpsUlgrMUE4STd3NFlDMHBNNldQTVRmNEhMTEdjZ2hEaFdr?=
 =?utf-8?B?THpQdVhmUTVZQVZoMG85dDJ6MHAzTm55UXlDMTRIa3oxYTUwSjhGcG1Cb1l1?=
 =?utf-8?B?Wi9Sb1ZzY2VCMjZwWGlyTDAxSEs2OGU5ejhQbFdCN3R6cFlub0V6Y3BjcnZS?=
 =?utf-8?B?Nk9QREQ3eTk2c0kwYTRnYkV3aHhCcGFkV0oxT2VNTHlEUFJOTnhabnZPSlN1?=
 =?utf-8?B?V1Z4bUVQbklKckZRZ2JKeDdKTFd6VVVwZnZLWTh6em1DZlZGWGxqeUZ5dkQy?=
 =?utf-8?B?QmlwM3lWWW9idmZhWXZQNHdWNEhsM1NRbE1vVTJqVk54YTFsWE0zaXVHcG1q?=
 =?utf-8?B?VjYrdEVOVEMwNUxOWm5XTHFGTkNMRDdCc0VuZzUrTmRwdE05eklxWXY3cWF0?=
 =?utf-8?B?bnNIWTVJa0NjaUhzdTNqZXVFN2Q4K3FHTHVxc3J5SWk4RFhMSUpiYnVrV0pk?=
 =?utf-8?B?TmJmQzkxV0xoYVFhZ3J2emI5STNUNVllWFMrSjNDYjMwdEt1ZS9KUkJ6Q0Ns?=
 =?utf-8?B?dDA2VkJoa3lVZE9iWXdTZVJ6NEFjZVdKNWR1cjN0K0pnQ1cxVmNSQUl5WEdl?=
 =?utf-8?B?cSt6Q0ltWk9CM3VMSlYwakVxSlBKTnMreGV1ZmQ1TG1weVJSQ0xONG02NGVn?=
 =?utf-8?B?UVdQcHgzcHBaQVViQ1krbTdBZUlQZUpSUE5Tb3hJcjdkMExXcG5aNHIyS1JF?=
 =?utf-8?Q?L9XoKnHDrrgCjYFSZJsHR/7oT?=
X-MS-Exchange-CrossTenant-Network-Message-Id: 56311239-5ff2-4283-eeee-08dc19045ba8
X-MS-Exchange-CrossTenant-AuthSource: PH7PR11MB5984.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 19 Jan 2024 15:36:09.0456
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 46c98d88-e344-4ed4-8496-4ed7712e255d
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: yUBPCW/u4CIakEBEKGGVVfqGvNTJLSDr9ksdhEOXaZRiOqFK6Tw6XL7RgBJ6+6SuX/pMYFvwhJtz+8z39FVpeA==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: SA1PR11MB8327
X-OriginatorOrg: intel.com


On 1/18/24 20:28, Randy Dunlap wrote:
> 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 <rdunlap@infradead.org>
> Cc: Jon Mason <jdmason@kudzu.us>
> Cc: Dave Jiang <dave.jiang@intel.com>
> Cc: Allen Hubbe <allenbh@gmail.com>
> Cc: ntb@lists.linux.dev

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

Thanks Randy!

> ---
>  drivers/ntb/ntb_transport.c |    8 +++++---
>  1 file changed, 5 insertions(+), 3 deletions(-)
> 
> diff -- a/drivers/ntb/ntb_transport.c b/drivers/ntb/ntb_transport.c
> --- a/drivers/ntb/ntb_transport.c
> +++ b/drivers/ntb/ntb_transport.c
> @@ -377,6 +377,8 @@ EXPORT_SYMBOL_GPL(ntb_transport_unregist
>   * @device_name: Name of NTB client device
>   *
>   * Register an NTB client device with the NTB transport layer
> + *
> + * Returns: %0 on success or -errno code on error
>   */
>  int ntb_transport_register_client_dev(char *device_name)
>  {
> @@ -1966,9 +1968,9 @@ static bool ntb_dma_filter_fn(struct dma
>  
>  /**
>   * 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: pointer for callback data
> + * @client_dev: &struct device pointer
> + * @handlers: pointer to various ntb queue (callback) handlers
>   *
>   * 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
>