2022-06-28 10:24:21

by Mauro Carvalho Chehab

Subject: [PATCH 12/22] drm: gpu_scheduler: fix a kernel-doc warning

The dev field was not documented:

include/drm/gpu_scheduler.h:463: warning: Function parameter or member 'dev' not described in 'drm_gpu_scheduler'

Document it.

Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---

To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover.
See [PATCH 00/22] at: https://lore.kernel.org/all/[email protected]/

include/drm/gpu_scheduler.h | 1 +
1 file changed, 1 insertion(+)

diff --git a/include/drm/gpu_scheduler.h b/include/drm/gpu_scheduler.h
index addb135eeea6..c7c487e0c40e 100644
--- a/include/drm/gpu_scheduler.h
+++ b/include/drm/gpu_scheduler.h
@@ -435,6 +435,7 @@ struct drm_sched_backend_ops {
* @_score: score used when the driver doesn't provide one
* @ready: marks if the underlying HW is ready to work
* @free_guilty: A hit to time out handler to free the guilty job.
+ * @dev: pointer to struct device.
*
* One scheduler is implemented for each hardware ring.
*/
--
2.36.1

2022-06-28 15:14:41

by Alex Deucher

Subject: Re: [PATCH 12/22] drm: gpu_scheduler: fix a kernel-doc warning

On Tue, Jun 28, 2022 at 5:46 AM Mauro Carvalho Chehab
<[email protected]> wrote:
>
> The dev field was not documented:
>
> include/drm/gpu_scheduler.h:463: warning: Function parameter or member 'dev' not described in 'drm_gpu_scheduler'
>
> Document it.
>
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>


Generally in the drm tree we use / rather than : in the patch titles. E.g.,

drm/scheduler: fix a kernel-doc warning

With that fixed:
Reviewed-by: Alex Deucher <[email protected]>

> ---
>
> To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover.
> See [PATCH 00/22] at: https://lore.kernel.org/all/[email protected]/
>
> include/drm/gpu_scheduler.h | 1 +
> 1 file changed, 1 insertion(+)
>
> diff --git a/include/drm/gpu_scheduler.h b/include/drm/gpu_scheduler.h
> index addb135eeea6..c7c487e0c40e 100644
> --- a/include/drm/gpu_scheduler.h
> +++ b/include/drm/gpu_scheduler.h
> @@ -435,6 +435,7 @@ struct drm_sched_backend_ops {
> * @_score: score used when the driver doesn't provide one
> * @ready: marks if the underlying HW is ready to work
> * @free_guilty: A hit to time out handler to free the guilty job.
> + * @dev: pointer to struct device.
> *
> * One scheduler is implemented for each hardware ring.
> */
> --
> 2.36.1
>