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

[PATCH v4 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>
Closes: https://lore.kernel.org/lkml/20250618150333.5ded99a0@canb.auug.org.au/
Reviewed-by: Raag Jadav <raag.jadav@intel.com>
Signed-off-by: André Almeida <andrealmeid@igalia.com>
---
v4: Drop new line at the end of file
v2: Add Reported-by tag
---
---
 Documentation/gpu/drm-uapi.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/gpu/drm-uapi.rst b/Documentation/gpu/drm-uapi.rst
index 263e5a97c080..5bc1da4915af 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
-- 
2.49.0

[PATCH v4 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>
Closes: https://lore.kernel.org/lkml/20250618151307.4a1a5e17@canb.auug.org.au/
Reviewed-by: Raag Jadav <raag.jadav@intel.com>
Signed-off-by: André Almeida <andrealmeid@igalia.com>
---
v4: Dropped "the" from the start of the sentence
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..a33aedd5e9ec 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: pid of the task */
 	pid_t pid;
+	/** @comm: command name of the task */
 	char comm[TASK_COMM_LEN];
 };
 
-- 
2.49.0

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

[André Almeida]

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

Reviewed-by: Raag Jadav <raag.jadav@intel.com>
Signed-off-by: André Almeida <andrealmeid@igalia.com>
---
 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 5bc1da4915af..843facf01b2d 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 v4 1/3] drm/doc: Fix title underline for "Task information"

[Bagas Sanjaya]

[-- Attachment #1: Type: text/plain, Size: 262 bytes --]

On Fri, Jul 04, 2025 at 04:07:22PM -0300, André Almeida wrote:
>  Task information
> ----------------
> +----------------
>  

LGTM, thanks!

Tested-by: Bagas Sanjaya <bagasdotme@gmail.com>

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

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

[Bagas Sanjaya]

[-- Attachment #1: Type: text/plain, Size: 283 bytes --]

On Fri, Jul 04, 2025 at 04:07:24PM -0300, André Almeida wrote:
> Remove the repetitive wording at the end of "Task information" section.
> 

Looks good, thanks!

Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
 
-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

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

[Randy Dunlap]

On 7/4/25 12:07 PM, André Almeida wrote:
> Remove the repetitive wording at the end of "Task information" section.
> 
> Reviewed-by: Raag Jadav <raag.jadav@intel.com>
> Signed-off-by: André Almeida <andrealmeid@igalia.com>
> ---
>  Documentation/gpu/drm-uapi.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)

Acked-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>

-- 
~Randy

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

[Randy Dunlap]

On 7/4/25 12:07 PM, 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>
> Closes: https://lore.kernel.org/lkml/20250618151307.4a1a5e17@canb.auug.org.au/
> Reviewed-by: Raag Jadav <raag.jadav@intel.com>
> Signed-off-by: André Almeida <andrealmeid@igalia.com>
> ---
> v4: Dropped "the" from the start of the sentence
> 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..a33aedd5e9ec 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: pid of the task */
>  	pid_t pid;
> +	/** @comm: command name of the task */
>  	char comm[TASK_COMM_LEN];
>  };
>  


Acked-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>

-- 
~Randy

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

[Randy Dunlap]

On 7/4/25 12:07 PM, 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>
> Closes: https://lore.kernel.org/lkml/20250618150333.5ded99a0@canb.auug.org.au/
> Reviewed-by: Raag Jadav <raag.jadav@intel.com>
> Signed-off-by: André Almeida <andrealmeid@igalia.com>
> ---
> v4: Drop new line at the end of file
> v2: Add Reported-by tag
> ---
> ---


Acked-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>

-- 
~Randy

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

[André Almeida]

Em 04/07/2025 16:07, André Almeida escreveu:
> Fix the following warning:
> 
> Documentation/gpu/drm-uapi.rst:450: WARNING: Title underline too short.
> 
> Task information
> --------------- [docutils]
> 

This series is now merged at drm-misc-next, thanks!

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

[Raag Jadav]

On Thu, Jul 10, 2025 at 06:27:45PM -0300, André Almeida wrote:
> Em 04/07/2025 16:07, André Almeida escreveu:
> > Fix the following warning:
> > 
> > Documentation/gpu/drm-uapi.rst:450: WARNING: Title underline too short.
> > 
> > Task information
> > --------------- [docutils]
> > 
> 
> This series is now merged at drm-misc-next, thanks!

Shouldn't this be drm-misc-fixes?

Also, this series continues to not land in my inbox. This is why I use raw
emails in my sendmail automation.

Raag

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

[André Almeida]

Em 10/07/2025 18:59, Raag Jadav escreveu:
> On Thu, Jul 10, 2025 at 06:27:45PM -0300, André Almeida wrote:
>> Em 04/07/2025 16:07, André Almeida escreveu:
>>> Fix the following warning:
>>>
>>> Documentation/gpu/drm-uapi.rst:450: WARNING: Title underline too short.
>>>
>>> Task information
>>> --------------- [docutils]
>>>
>>
>> This series is now merged at drm-misc-next, thanks!
> 
> Shouldn't this be drm-misc-fixes?
> 

The commits that those patches fixes can't be found on drm-misc-fixes as 
it's now, so I thought I should merge it at drm-misc-next.

> Also, this series continues to not land in my inbox. This is why I use raw
> emails in my sendmail automation.
> 
> Raag