Subject: Re: [PATCH] drm: ttm: correct ttm_range_manager kernel-doc notation
To:     Huang Rui <ray.huang@amd.com>, Randy Dunlap <rdunlap@infradead.org>
Cc:     "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
        kernel test robot <lkp@intel.com>,
        "dri-devel@lists.freedesktop.org" <dri-devel@lists.freedesktop.org>
References: <20211121155453.29736-1-rdunlap@infradead.org>
 <YZsLJOUUBMnBUCu7@hr-amd>
From:   =?UTF-8?Q?Christian_K=c3=b6nig?= <christian.koenig@amd.com>
Message-ID: <bf091e6e-3add-c335-85a0-95e9a93a19a0@amd.com>
Date:   Mon, 22 Nov 2021 21:33:55 +0100
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101
 Thunderbird/78.13.0
In-Reply-To: <YZsLJOUUBMnBUCu7@hr-amd>
Content-Type: text/plain; charset=utf-8; format=flowed
Content-Transfer-Encoding: 8bit
Content-Language: en-US
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?MlN5bVY0UWt1bGo2cWtCVk5DalI5MW5IZnp4bi9BNStoZ2VxeVRKSHM2eHly?=
 =?utf-8?B?d1ZEZE9OaThDM3pBcDBkdzhQWG1QbHczV3o0Vjd3QkZzMGlvZk52WGFKeHQx?=
 =?utf-8?B?aVdGdTFnSTYxU2h1UEFXb0lDMUxna05LSE1DMW5rQmRRbkhESmttODN2SUp1?=
 =?utf-8?B?VGZzeXhwSThxeUpRRFAxb0J6VWVxaTV5UXNpeFYvb1NTam1kVVN0L2hKSUhp?=
 =?utf-8?B?UVNMd1MvU2tyVk85clVtVE16VXh4N0p3WEhtRHorTTBsMnNqaWxkWmVrZ3hl?=
 =?utf-8?B?bk1BU0RuSGdVb2gyQ3JKVkRwZ3FIQ1ZUVEZxWVpEN1EzM1Z4S0xxUzBtZGMz?=
 =?utf-8?B?dXJiSUV3WmUyMkJGbXNzQlA4VjgrUEh0R0xtUGlyY0F6bjY5eDJSU2VHWWpM?=
 =?utf-8?B?Z1hycUZTVm1UcXBrWjJ5OGMzaUdqWm1hNkNlcUE5M0FncEVoaHVYWEl5ekdo?=
 =?utf-8?B?b1B0WXN3Zk1TRXMrcGtqSEpRMVRMem1HeFdiUUpQM1RxTGErU0pwMFJqeGZF?=
 =?utf-8?B?R1k4ZDI3T1pIOXRKVzAwcWdIQjdsVzlSUGwyY3NRbUR0OHFLdjVjSE5FSmhK?=
 =?utf-8?B?dk1jYVczOHppaENOTnlhTEN4NWtlaGdnWHRraFU5aHZDYWlFSUZtbnE1Yjh3?=
 =?utf-8?B?KzJ4R2lraGlGNW16WWtPd1RZcGx4ZHZQbllhcjRNK3NFUjYwUG10MEFIYTd3?=
 =?utf-8?B?djRaUlZzZlNVUGpwd1RBbnFBQ0R1UXFZMVVFa0pRdDZpN2labWNWSEhTaVNu?=
 =?utf-8?B?ek9qZzQxMlNYTDVrT1JyYVBEb0FwajNYZXRZdkJXaDNVTFdjOU5FVlJpNXdt?=
 =?utf-8?B?cVZTNnUwM2t4RWJORXM4MGtNL3pyRzBrdDhpSkx3Ny92K0pvKzk3WkVTZnBu?=
 =?utf-8?B?N0owVDN3RVpjVHFhdjR6SEY4SVg5K3FnYnpLOFMxS25td2JQVDYwdzNtVTk2?=
 =?utf-8?B?NnVKRHBzMGRJWm1QVStNVVJYTkNGWHFINTlSMzNaUU55QUJzNDBQNDBCbjdG?=
 =?utf-8?B?SnU5d0JKckd3dElZZWhHUEdTV0tCdEhSV3F1WEdKOXI3RGNMNDI0Wnp2R0dp?=
 =?utf-8?B?a2dLUldId0xuTmtvSkF4c0wzMDdWazg4OHFNcU14a3FOaW9JZWFKTWVxQlVT?=
 =?utf-8?B?OGt5MVlHQUx0Sk9BSU9jWERSdHlWdGs0WDRxaHZqVE1LcGJ4OEphcVR1WXV0?=
 =?utf-8?B?TVZDcmdqSWlRVEMwYk8xbHZ3QXYreHYvMTMyUGFFZ3RIamFxaVJWTFNGQmRo?=
 =?utf-8?B?QVY5UG4zanhsQ2UzMjhZbEZIWnFkTG12ZmcxRWU5d3ZtZWRvV2lJT24yQ2lG?=
 =?utf-8?B?dGg2Rmx0RUZ1azI0NEdSSzRwb25ZdEtwQWtXMVBqZGprSW8vQjR2NzM0akw5?=
 =?utf-8?B?WjBJK1lXNk5LRmlKWU9jSmpQaU1QRGI1OUNpQWZYV21CeFdlbFRUNTVVeXlP?=
 =?utf-8?B?MEVkZXh6VHZSVmt5QW9hUkV6SUY3cHhJcUZSemRSd3pkY3hPS0l1ckgrZFly?=
 =?utf-8?B?a2QxSVNEMHMyY2kreUcydTJFQ1JaMlVhYmVJVHM0bXJDcEpKS0JDMmJKbXlW?=
 =?utf-8?B?cWJzT3ZmaE96UC92N2xwbnB1MFpEL1VKaVR0NEtIYUNjcmNONG1RUExTOEZK?=
 =?utf-8?B?ek16YnBhOWRtaS93QzhJV2NtcWVvYlFTb280Y1YwTDdWWVBYRDRyNFVqZnVU?=
 =?utf-8?B?aUVyYkpidU44TjdrUXB6YzJ5Wk9pWDNSMmJkT01qaXpyQi9iZFB6WkJSUUZJ?=
 =?utf-8?B?LytCRkNjOTBmclFDSVBISExBN3pCMEhBbUFuWkxpUlFXZXpMZ3loR2x5ajlR?=
 =?utf-8?B?Qnl4MGszQzJ3cURmSjZpUWpQNCtxdlN2YU5icDJtOGo4dGtFYzJmWFExUnM2?=
 =?utf-8?B?ZzNTL0FpSTZPRHZSM3VRVmVRMFFETnNVOFdDeHlFWXhhbTR5T05uVVpDSFpz?=
 =?utf-8?B?UEpTbVJLTmdYWVVhNXFPVk9KOU9MNlFIKzZGR1Y5cHdVY0FmVkJEUDZ1bzl3?=
 =?utf-8?B?VkZDME1naWh2R3k4YUNsY3N1blZKYkVZNGd2QjhIVlI5MmtsZHREeE1WUDl0?=
 =?utf-8?B?M3NNQk9XTUZZN1NLZkhPRlVRVmdnTTUycHNZcVMwSEI1NTBiT1R6SkorOFF1?=
 =?utf-8?B?eURSb0tGR1ozRHVua3ZHOWxZM3ZVNTFjakc0MnpiTU9LTVRrRFA5bmNCMkwv?=
 =?utf-8?Q?AdxHmuq4crupJFwrxrfXoZ4=3D?=
X-OriginatorOrg: amd.com
X-MS-Exchange-CrossTenant-Network-Message-Id: c9f14d3c-ea96-4172-776f-08d9adf76a85
X-MS-Exchange-CrossTenant-AuthSource: MWHPR1201MB0192.namprd12.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 22 Nov 2021 20:34:01.1981
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 3dd8961f-e488-4e60-8e11-a82d994e183d
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: yRrY4FViXTVn5I1bNu/2lb0Fur3xx3u49vgS0NmNzZfC9e37DilosGh8eMk+//kt
X-MS-Exchange-Transport-CrossTenantHeadersStamped: MWHPR12MB1774
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

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)