[PATCH] drm: ttm: correct ttm_range_manager kernel-doc notation

[PATCH] drm: ttm: correct ttm_range_manager kernel-doc notation

[Randy Dunlap]

Fix kernel-doc warnings in ttm_range_manager.c:

drivers/gpu/drm/ttm/ttm_range_manager.c:144: warning: expecting prototype for ttm_range_man_init(). Prototype was for ttm_range_man_init_nocheck() instead
drivers/gpu/drm/ttm/ttm_range_manager.c:178: warning: expecting prototype for ttm_range_man_fini(). Prototype was for ttm_range_man_fini_nocheck() instead

Also fix subsequent warnings from scripts/kernel-doc.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reported-by: kernel test robot <lkp@intel.com>
Cc: Christian König <christian.koenig@amd.com>
Cc: Huang Rui <ray.huang@amd.com>
Cc: dri-devel@lists.freedesktop.org
---
 drivers/gpu/drm/ttm/ttm_range_manager.c |   11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)

--- linux-next-20211118.orig/drivers/gpu/drm/ttm/ttm_range_manager.c
+++ linux-next-20211118/drivers/gpu/drm/ttm/ttm_range_manager.c
@@ -128,15 +128,17 @@ static const struct ttm_resource_manager
 };
 
 /**
- * ttm_range_man_init
+ * ttm_range_man_init_nocheck - Initialise a generic range manager for the
+ * selected memory type.
  *
  * @bdev: ttm device
  * @type: memory manager type
  * @use_tt: if the memory manager uses tt
  * @p_size: size of area to be managed in pages.
  *
- * Initialise a generic range manager for the selected memory type.
  * The range manager is installed for this device in the type slot.
+ *
+ * Return: %0 on success or a negative error code on failure
  */
 int ttm_range_man_init_nocheck(struct ttm_device *bdev,
 		       unsigned type, bool use_tt,
@@ -166,12 +168,13 @@ int ttm_range_man_init_nocheck(struct tt
 EXPORT_SYMBOL(ttm_range_man_init_nocheck);
 
 /**
- * ttm_range_man_fini
+ * ttm_range_man_fini_nocheck - Remove the generic range manager from a slot
+ * and tear it down.
  *
  * @bdev: ttm device
  * @type: memory manager type
  *
- * Remove the generic range manager from a slot and tear it down.
+ * Return: %0 on success or a negative error code on failure
  */
 int ttm_range_man_fini_nocheck(struct ttm_device *bdev,
 		       unsigned type)

Re: [PATCH] drm: ttm: correct ttm_range_manager kernel-doc notation

[Huang Rui]

On Sun, Nov 21, 2021 at 11:54:52PM +0800, Randy Dunlap wrote:
> Fix kernel-doc warnings in ttm_range_manager.c:
> 
> drivers/gpu/drm/ttm/ttm_range_manager.c:144: warning: expecting prototype for ttm_range_man_init(). Prototype was for ttm_range_man_init_nocheck() instead
> drivers/gpu/drm/ttm/ttm_range_manager.c:178: warning: expecting prototype for ttm_range_man_fini(). Prototype was for ttm_range_man_fini_nocheck() instead
> 
> Also fix subsequent warnings from scripts/kernel-doc.
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Reported-by: kernel test robot <lkp@intel.com>
> Cc: Christian König <christian.koenig@amd.com>
> Cc: Huang Rui <ray.huang@amd.com>
> Cc: dri-devel@lists.freedesktop.org

Reviewed-by: Huang Rui <ray.huang@amd.com>

> ---
>  drivers/gpu/drm/ttm/ttm_range_manager.c |   11 +++++++----
>  1 file changed, 7 insertions(+), 4 deletions(-)
> 
> --- linux-next-20211118.orig/drivers/gpu/drm/ttm/ttm_range_manager.c
> +++ linux-next-20211118/drivers/gpu/drm/ttm/ttm_range_manager.c
> @@ -128,15 +128,17 @@ static const struct ttm_resource_manager
>  };
>  
>  /**
> - * ttm_range_man_init
> + * ttm_range_man_init_nocheck - Initialise a generic range manager for the
> + * selected memory type.
>   *
>   * @bdev: ttm device
>   * @type: memory manager type
>   * @use_tt: if the memory manager uses tt
>   * @p_size: size of area to be managed in pages.
>   *
> - * Initialise a generic range manager for the selected memory type.
>   * The range manager is installed for this device in the type slot.
> + *
> + * Return: %0 on success or a negative error code on failure
>   */
>  int ttm_range_man_init_nocheck(struct ttm_device *bdev,
>  		       unsigned type, bool use_tt,
> @@ -166,12 +168,13 @@ int ttm_range_man_init_nocheck(struct tt
>  EXPORT_SYMBOL(ttm_range_man_init_nocheck);
>  
>  /**
> - * ttm_range_man_fini
> + * ttm_range_man_fini_nocheck - Remove the generic range manager from a slot
> + * and tear it down.
>   *
>   * @bdev: ttm device
>   * @type: memory manager type
>   *
> - * Remove the generic range manager from a slot and tear it down.
> + * Return: %0 on success or a negative error code on failure
>   */
>  int ttm_range_man_fini_nocheck(struct ttm_device *bdev,
>  		       unsigned type)

Re: [PATCH] drm: ttm: correct ttm_range_manager kernel-doc notation

[Christian König]

Am 22.11.21 um 04:14 schrieb Huang Rui:
> On Sun, Nov 21, 2021 at 11:54:52PM +0800, Randy Dunlap wrote:
>> Fix kernel-doc warnings in ttm_range_manager.c:
>>
>> drivers/gpu/drm/ttm/ttm_range_manager.c:144: warning: expecting prototype for ttm_range_man_init(). Prototype was for ttm_range_man_init_nocheck() instead
>> drivers/gpu/drm/ttm/ttm_range_manager.c:178: warning: expecting prototype for ttm_range_man_fini(). Prototype was for ttm_range_man_fini_nocheck() instead
>>
>> Also fix subsequent warnings from scripts/kernel-doc.
>>
>> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
>> Reported-by: kernel test robot <lkp@intel.com>
>> Cc: Christian König <christian.koenig@amd.com>
>> Cc: Huang Rui <ray.huang@amd.com>
>> Cc: dri-devel@lists.freedesktop.org
> Reviewed-by: Huang Rui <ray.huang@amd.com>

Reviewed-by: Christian König <christian.koenig@amd.com> and pushed to 
drm-misc-next.

Thanks for the help,
Christian.

>
>> ---
>>   drivers/gpu/drm/ttm/ttm_range_manager.c |   11 +++++++----
>>   1 file changed, 7 insertions(+), 4 deletions(-)
>>
>> --- linux-next-20211118.orig/drivers/gpu/drm/ttm/ttm_range_manager.c
>> +++ linux-next-20211118/drivers/gpu/drm/ttm/ttm_range_manager.c
>> @@ -128,15 +128,17 @@ static const struct ttm_resource_manager
>>   };
>>   
>>   /**
>> - * ttm_range_man_init
>> + * ttm_range_man_init_nocheck - Initialise a generic range manager for the
>> + * selected memory type.
>>    *
>>    * @bdev: ttm device
>>    * @type: memory manager type
>>    * @use_tt: if the memory manager uses tt
>>    * @p_size: size of area to be managed in pages.
>>    *
>> - * Initialise a generic range manager for the selected memory type.
>>    * The range manager is installed for this device in the type slot.
>> + *
>> + * Return: %0 on success or a negative error code on failure
>>    */
>>   int ttm_range_man_init_nocheck(struct ttm_device *bdev,
>>   		       unsigned type, bool use_tt,
>> @@ -166,12 +168,13 @@ int ttm_range_man_init_nocheck(struct tt
>>   EXPORT_SYMBOL(ttm_range_man_init_nocheck);
>>   
>>   /**
>> - * ttm_range_man_fini
>> + * ttm_range_man_fini_nocheck - Remove the generic range manager from a slot
>> + * and tear it down.
>>    *
>>    * @bdev: ttm device
>>    * @type: memory manager type
>>    *
>> - * Remove the generic range manager from a slot and tear it down.
>> + * Return: %0 on success or a negative error code on failure
>>    */
>>   int ttm_range_man_fini_nocheck(struct ttm_device *bdev,
>>   		       unsigned type)