Message ID | 20230203100215.31852-3-bagasdotme@gmail.com (mailing list archive) |
---|---|
State | New, archived |
Headers | show |
Series | htmldocs fixes for next-20230203 | expand |
Am Freitag, dem 03.02.2023 um 17:02 +0700 schrieb Bagas Sanjaya: > Stephen Rothwell reported htmldocs warnings: > > include/drm/gpu_scheduler.h:232: warning: Incorrect use of kernel-doc format: * @elapsed_ns > include/drm/gpu_scheduler.h:238: warning: Function parameter or member 'elapsed_ns' not described in 'drm_sched_entity' > > Fix the error by appending missing colon to @elapsed_ns name in its > kernel-doc comment. > Thanks, I've added this to the etnaviv tree. Since the commit is only in -next and not a non-rebase tree yet, I might be tempted to squash the fix into the offending commit. What would be the right way to credit you for the fix in that case? Regards, Lucas > Link: https://lore.kernel.org/linux-next/20230203135027.1a4679d3@canb.auug.org.au/ > Fixes: 248cd9b265fca6 ("drm/scheduler: track GPU active time per entity") > Reported-by: Stephen Rothwell <sfr@canb.auug.org.au> > Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> > --- > include/drm/gpu_scheduler.h | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/include/drm/gpu_scheduler.h b/include/drm/gpu_scheduler.h > index 9a50365621ed8d..9db9e5e504eeb3 100644 > --- a/include/drm/gpu_scheduler.h > +++ b/include/drm/gpu_scheduler.h > @@ -229,7 +229,7 @@ struct drm_sched_entity { > struct rb_node rb_tree_node; > > /** > - * @elapsed_ns > + * @elapsed_ns: > * > * Records the amount of time where jobs from this entity were active > * on the GPU.
On 2/3/23 18:27, Lucas Stach wrote: > Thanks, I've added this to the etnaviv tree. > > Since the commit is only in -next and not a non-rebase tree yet, I > might be tempted to squash the fix into the offending commit. What > would be the right way to credit you for the fix in that case? > On SoB area, you can add: [Bagas: Append missing colon to @elapsed_ns] Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> Thanks.
diff --git a/include/drm/gpu_scheduler.h b/include/drm/gpu_scheduler.h index 9a50365621ed8d..9db9e5e504eeb3 100644 --- a/include/drm/gpu_scheduler.h +++ b/include/drm/gpu_scheduler.h @@ -229,7 +229,7 @@ struct drm_sched_entity { struct rb_node rb_tree_node; /** - * @elapsed_ns + * @elapsed_ns: * * Records the amount of time where jobs from this entity were active * on the GPU.
Stephen Rothwell reported htmldocs warnings: include/drm/gpu_scheduler.h:232: warning: Incorrect use of kernel-doc format: * @elapsed_ns include/drm/gpu_scheduler.h:238: warning: Function parameter or member 'elapsed_ns' not described in 'drm_sched_entity' Fix the error by appending missing colon to @elapsed_ns name in its kernel-doc comment. Link: https://lore.kernel.org/linux-next/20230203135027.1a4679d3@canb.auug.org.au/ Fixes: 248cd9b265fca6 ("drm/scheduler: track GPU active time per entity") Reported-by: Stephen Rothwell <sfr@canb.auug.org.au> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> --- include/drm/gpu_scheduler.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)