[PATCH v3 1/3] drm/doc: Fix title underline for "Task information"

[PATCH v3 1/3] 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 v3 2/3] 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>
---
v3: Make it consistent with drm_device member description
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..73dd3c5470a4 100644
--- a/include/drm/drm_device.h
+++ b/include/drm/drm_device.h
@@ -35,7 +35,9 @@ struct pci_controller;
  * struct drm_wedge_task_info - information about the guilty task of a wedge dev
  */
 struct drm_wedge_task_info {
+ 	/** @pid: the pid of the task */
 	pid_t pid;
+ 	/** @comm: the command name of the task */
 	char comm[TASK_COMM_LEN];
 };
 
-- 
2.49.0

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

[Raag Jadav]

On Fri, Jun 27, 2025 at 02:17:14PM -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>
> ---
> v3: Make it consistent with drm_device member description
> 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..73dd3c5470a4 100644
> --- a/include/drm/drm_device.h
> +++ b/include/drm/drm_device.h
> @@ -35,7 +35,9 @@ struct pci_controller;
>   * struct drm_wedge_task_info - information about the guilty task of a wedge dev
>   */
>  struct drm_wedge_task_info {
> + 	/** @pid: the pid of the task */

Nit: Can be simply "pid of the task" without initial "the".

>  	pid_t pid;
> + 	/** @comm: the command name of the task */

Ditto.

>  	char comm[TASK_COMM_LEN];

But in any case,

Reviewed-by: Raag Jadav <raag.jadav@intel.com>

[PATCH v3 3/3] drm/doc: Fix grammar for "Task information"

[André Almeida]

Remove the repetitive wording at the end of "Task information" section.

Signed-off-by: André Almeida <andrealmeid@igalia.com>
---
v3: new patch
---
 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 10dea6a1f097..3ed027bac028 100644
--- a/Documentation/gpu/drm-uapi.rst
+++ b/Documentation/gpu/drm-uapi.rst
@@ -460,8 +460,8 @@ event string.
 
 The reliability of this information is driver and hardware specific, and should
 be taken with a caution regarding it's precision. To have a big picture of what
-really happened, the devcoredump file provides should have much more detailed
-information about the device state and about the event.
+really happened, the devcoredump file provides much more detailed information
+about the device state and about the event.
 
 Consumer prerequisites
 ----------------------
-- 
2.49.0

Re: [PATCH v3 3/3] drm/doc: Fix grammar for "Task information"

[Raag Jadav]

On Fri, Jun 27, 2025 at 02:17:15PM -0300, André Almeida wrote:
> Remove the repetitive wording at the end of "Task information" section.
> 
> Signed-off-by: André Almeida <andrealmeid@igalia.com>

Reviewed-by: Raag Jadav <raag.jadav@intel.com>

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

[André Almeida]

Raag, gently ping for reviewing this series.

Em 27/06/2025 14:17, 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 v3 1/3] drm/doc: Fix title underline for "Task information"

[Raag Jadav]

On Fri, Jul 04, 2025 at 01:46:07PM -0300, André Almeida wrote:
> Raag, gently ping for reviewing this series.

Somehow this didn't land in my inbox and I have no idea why.

Raag

> Em 27/06/2025 14:17, 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 v3 1/3] drm/doc: Fix title underline for "Task information"

[Raag Jadav]

On Fri, Jun 27, 2025 at 02:17:13PM -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
> ----------------
> +----------------
>  
>  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

Unrelated change. Someone with a different editor added this and now
your editor disagrees with it.

Switching to binary mode usually fixes the issue.

Raag

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

[André Almeida]

Em 04/07/2025 15:41, Raag Jadav escreveu:
> On Fri, Jun 27, 2025 at 02:17:13PM -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
>> ----------------
>> +----------------
>>   
>>   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
> 
> Unrelated change. Someone with a different editor added this and now
> your editor disagrees with it.
> 
> Switching to binary mode usually fixes the issue.
> 
> Raag

After fixing that, can I add your Reviewed-by:?

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

[Raag Jadav]

On Fri, Jul 04, 2025 at 03:49:36PM -0300, André Almeida wrote:
> Em 04/07/2025 15:41, Raag Jadav escreveu:
> > On Fri, Jun 27, 2025 at 02:17:13PM -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
> > > ----------------
> > > +----------------
> > >   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
> > 
> > Unrelated change. Someone with a different editor added this and now
> > your editor disagrees with it.
> > 
> > Switching to binary mode usually fixes the issue.
> > 
> > Raag
> 
> After fixing that, can I add your Reviewed-by:?

Sure. Feel free to add,

Reviewed-by: Raag Jadav <raag.jadav@intel.com>