Re: [PATCH v2] A simple doc fix

Andrey Grodzovsky <andrey.grodzovsky@xxxxxxx> · Tue, 20 Sep 2022 12:54:28 -0400

Reviewed-by: Andrey Grodzovsky <andrey.grodzovsky@xxxxxxx>

Will push it to drm-misc-next

Thanks,

Andrey

On 2022-09-20 02:46, Anup K Parikh wrote:
Fix two warnings during doc build which also results in corresponding
additions in generated docs

Warnings Fixed:
1. include/drm/gpu_scheduler.h:462: warning: Function parameter or member
    'dev' not described in 'drm_gpu_scheduler'
2. drivers/gpu/drm/scheduler/sched_main.c:1005: warning: Function
    parameter or member 'dev' not described in 'drm_sched_init'

Signed-off-by: Anup K Parikh <parikhanupk.foss@xxxxxxxxx>
---
Changes in v2:
     Correct the doc strings according to
     Link: https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2Flore.kernel.org%2Fall%2Ff528a8e4-5162-66d5-09da-5252076882b8%40amd.com%2F&amp;data=05%7C01%7Candrey.grodzovsky%40amd.com%7Ccbef53d3f32845465ce908da9ad3f29b%7C3dd8961fe4884e608e11a82d994e183d%7C0%7C0%7C637992532358603366%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&amp;sdata=PnHCvtDFVWnb25YkDfjHcmy9MBpLCA462xco799rjJs%3D&amp;reserved=0
  drivers/gpu/drm/scheduler/sched_main.c | 2 ++
  include/drm/gpu_scheduler.h            | 2 ++
  2 files changed, 4 insertions(+)

diff --git a/drivers/gpu/drm/scheduler/sched_main.c b/drivers/gpu/drm/scheduler/sched_main.c
index 68317d3a7a27..979685830671 100644
--- a/drivers/gpu/drm/scheduler/sched_main.c
+++ b/drivers/gpu/drm/scheduler/sched_main.c
@@ -994,6 +994,8 @@ static int drm_sched_main(void *param)
   *		used
   * @score: optional score atomic shared with other schedulers
   * @name: name used for debugging
+ * @dev: A device pointer - primarily useful for printing standardized
+ *       messages with DRM_DEV_ERROR().
   *
   * Return 0 on success, otherwise error code.
   */
diff --git a/include/drm/gpu_scheduler.h b/include/drm/gpu_scheduler.h
index addb135eeea6..80a525dd19bd 100644
--- a/include/drm/gpu_scheduler.h
+++ b/include/drm/gpu_scheduler.h
@@ -435,6 +435,8 @@ 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: A device pointer - primarily useful for printing standardized
+ *       messages with DRM_DEV_ERROR().
   *
   * One scheduler is implemented for each hardware ring.
   */






