[PATCH v2 1/2] drm/doc: Fix title underline for "Task information"

[PATCH v2 1/2] drm/doc: Fix title underline for "Task information"

[André Almeida]

Fix the following warning:

Documentation/gpu/drm-uapi.rst:450: WARNING: Title underline too short.

Task information
--------------- [docutils]

Fixes: cd37124b4093 ("drm/doc: Add a section about "Task information" for the wedge API")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: André Almeida <andrealmeid@igalia.com>
---
v2: Add Reported-by tag
---
 Documentation/gpu/drm-uapi.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/gpu/drm-uapi.rst b/Documentation/gpu/drm-uapi.rst
index 263e5a97c080..10dea6a1f097 100644
--- a/Documentation/gpu/drm-uapi.rst
+++ b/Documentation/gpu/drm-uapi.rst
@@ -447,7 +447,7 @@ hang is usually the most critical one which can result in consequential hangs or
 complete wedging.
 
 Task information
----------------
+----------------
 
 The information about which application (if any) was involved in the device
 wedging is useful for userspace if they want to notify the user about what
@@ -728,4 +728,4 @@ Stable uAPI events
 From ``drivers/gpu/drm/scheduler/gpu_scheduler_trace.h``
 
 .. kernel-doc::  drivers/gpu/drm/scheduler/gpu_scheduler_trace.h
-   :doc: uAPI trace events
\ No newline at end of file
+   :doc: uAPI trace events
-- 
2.49.0

[PATCH v2 2/2] drm: Add missing struct drm_wedge_task_info kernel doc

[André Almeida]

Fix the following kernel doc warning:

include/drm/drm_device.h:40: warning: Function parameter or struct member 'pid' not described in 'drm_wedge_task_info'
include/drm/drm_device.h:40: warning: Function parameter or struct member 'comm' not described in 'drm_wedge_task_info'

Fixes: 183bccafa176 ("drm: Create a task info option for wedge events")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: André Almeida <andrealmeid@igalia.com>
---
v2: Add Reported-by tag
---
 include/drm/drm_device.h | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/include/drm/drm_device.h b/include/drm/drm_device.h
index 08b3b2467c4c..aae0800ccef1 100644
--- a/include/drm/drm_device.h
+++ b/include/drm/drm_device.h
@@ -33,6 +33,8 @@ struct pci_controller;
 
 /**
  * struct drm_wedge_task_info - information about the guilty task of a wedge dev
+ * @pid:	the pid of the task
+ * @comm:	the command name of the task
  */
 struct drm_wedge_task_info {
 	pid_t pid;
-- 
2.49.0

Re: [PATCH v2 2/2] drm: Add missing struct drm_wedge_task_info kernel doc

[Raag Jadav]

On Thu, Jun 19, 2025 at 11:06:55AM -0300, André Almeida wrote:
> Fix the following kernel doc warning:
> 
> include/drm/drm_device.h:40: warning: Function parameter or struct member 'pid' not described in 'drm_wedge_task_info'
> include/drm/drm_device.h:40: warning: Function parameter or struct member 'comm' not described in 'drm_wedge_task_info'
> 
> Fixes: 183bccafa176 ("drm: Create a task info option for wedge events")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Signed-off-by: André Almeida <andrealmeid@igalia.com>
> ---
> v2: Add Reported-by tag
> ---
>  include/drm/drm_device.h | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git a/include/drm/drm_device.h b/include/drm/drm_device.h
> index 08b3b2467c4c..aae0800ccef1 100644
> --- a/include/drm/drm_device.h
> +++ b/include/drm/drm_device.h
> @@ -33,6 +33,8 @@ struct pci_controller;
>  
>  /**
>   * struct drm_wedge_task_info - information about the guilty task of a wedge dev
> + * @pid:	the pid of the task
> + * @comm:	the command name of the task

Redundant tabs. A whitespace is ususally good enough for docs.

Raag

>   */
>  struct drm_wedge_task_info {
>  	pid_t pid;
> -- 
> 2.49.0
> 

Re: [PATCH v2 2/2] drm: Add missing struct drm_wedge_task_info kernel doc

[Raag Jadav]

On Fri, Jun 27, 2025 at 04:03:32PM +0300, Raag Jadav wrote:
> On Thu, Jun 19, 2025 at 11:06:55AM -0300, André Almeida wrote:
> > Fix the following kernel doc warning:
> > 
> > include/drm/drm_device.h:40: warning: Function parameter or struct member 'pid' not described in 'drm_wedge_task_info'
> > include/drm/drm_device.h:40: warning: Function parameter or struct member 'comm' not described in 'drm_wedge_task_info'
> > 
> > Fixes: 183bccafa176 ("drm: Create a task info option for wedge events")
> > Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> > Signed-off-by: André Almeida <andrealmeid@igalia.com>
> > ---
> > v2: Add Reported-by tag
> > ---
> >  include/drm/drm_device.h | 2 ++
> >  1 file changed, 2 insertions(+)
> > 
> > diff --git a/include/drm/drm_device.h b/include/drm/drm_device.h
> > index 08b3b2467c4c..aae0800ccef1 100644
> > --- a/include/drm/drm_device.h
> > +++ b/include/drm/drm_device.h
> > @@ -33,6 +33,8 @@ struct pci_controller;
> >  
> >  /**
> >   * struct drm_wedge_task_info - information about the guilty task of a wedge dev
> > + * @pid:	the pid of the task
> > + * @comm:	the command name of the task
> 
> Redundant tabs. A whitespace is ususally good enough for docs.

Also, let's be consistent with struct drm_device for member description.

Raag

> >   */
> >  struct drm_wedge_task_info {
> >  	pid_t pid;
> > -- 
> > 2.49.0
> > 

Re: [PATCH v2 1/2] drm/doc: Fix title underline for "Task information"

[André Almeida]

Hi Raag,

Can you give me a Reviewed-by/Acked-by for this series before I push to 
drm-misc-next?

Em 19/06/2025 11:06, André Almeida escreveu:
> Fix the following warning:
> 
> Documentation/gpu/drm-uapi.rst:450: WARNING: Title underline too short.
> 
> Task information
> --------------- [docutils]
> 
> Fixes: cd37124b4093 ("drm/doc: Add a section about "Task information" for the wedge API")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Signed-off-by: André Almeida <andrealmeid@igalia.com>
> ---
> v2: Add Reported-by tag
> ---
>   Documentation/gpu/drm-uapi.rst | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/gpu/drm-uapi.rst b/Documentation/gpu/drm-uapi.rst
> index 263e5a97c080..10dea6a1f097 100644
> --- a/Documentation/gpu/drm-uapi.rst
> +++ b/Documentation/gpu/drm-uapi.rst
> @@ -447,7 +447,7 @@ hang is usually the most critical one which can result in consequential hangs or
>   complete wedging.
>   
>   Task information
> ----------------
> +----------------
>   
>   The information about which application (if any) was involved in the device
>   wedging is useful for userspace if they want to notify the user about what
> @@ -728,4 +728,4 @@ Stable uAPI events
>   From ``drivers/gpu/drm/scheduler/gpu_scheduler_trace.h``
>   
>   .. kernel-doc::  drivers/gpu/drm/scheduler/gpu_scheduler_trace.h
> -   :doc: uAPI trace events
> \ No newline at end of file
> +   :doc: uAPI trace events

Re: [PATCH v2 1/2] drm/doc: Fix title underline for "Task information"

[Raag Jadav]

On Thu, Jun 19, 2025 at 11:06:54AM -0300, André Almeida wrote:
> Fix the following warning:
> 
> Documentation/gpu/drm-uapi.rst:450: WARNING: Title underline too short.
> 
> Task information
> --------------- [docutils]
> 
> Fixes: cd37124b4093 ("drm/doc: Add a section about "Task information" for the wedge API")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Signed-off-by: André Almeida <andrealmeid@igalia.com>
> ---
> v2: Add Reported-by tag
> ---
>  Documentation/gpu/drm-uapi.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/gpu/drm-uapi.rst b/Documentation/gpu/drm-uapi.rst
> index 263e5a97c080..10dea6a1f097 100644
> --- a/Documentation/gpu/drm-uapi.rst
> +++ b/Documentation/gpu/drm-uapi.rst
> @@ -447,7 +447,7 @@ hang is usually the most critical one which can result in consequential hangs or
>  complete wedging.
>  
>  Task information
> ----------------
> +----------------

Since we're here, can you please also fix the grammar in last sentence
of this section? I presume you meant to use either "provides" or "should
have" and not both? ;)

Raag

>  The information about which application (if any) was involved in the device
>  wedging is useful for userspace if they want to notify the user about what
> @@ -728,4 +728,4 @@ Stable uAPI events
>  From ``drivers/gpu/drm/scheduler/gpu_scheduler_trace.h``
>  
>  .. kernel-doc::  drivers/gpu/drm/scheduler/gpu_scheduler_trace.h
> -   :doc: uAPI trace events
> \ No newline at end of file
> +   :doc: uAPI trace events
> -- 
> 2.49.0
>