* [PATCH v2] drm/imagination: Document pvr_device.power member
@ 2025-11-21 15:20 Matt Coster
2025-11-21 16:43 ` Alessio Belle
` (3 more replies)
0 siblings, 4 replies; 5+ messages in thread
From: Matt Coster @ 2025-11-21 15:20 UTC (permalink / raw)
To: Frank Binns, Alessio Belle, Alexandru Dadu, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter
Cc: Stephen Rothwell, Matt Coster, dri-devel, linux-kernel,
linux-next
Automated testing caught this missing doc comment; add something suitable
(and useful).
Fixes: 330e76d31697 ("drm/imagination: Add power domain control")
Reported-by: Stephen Rothwell <sfr@canb•auug.org.au>
Closes: https://lore.kernel.org/r/20251106152448.453b53ad@canb.auug.org.au/
Signed-off-by: Matt Coster <matt.coster@imgtec•com>
---
Based on the build target indicated in the report, I tried (and failed)
to reproduce the reported warning using:
make W=1 htmldocs
I was, however, able to get the reported warning (and verify that this
patch clears it) using:
scripts/kernel-doc -none drivers/gpu/drm/imagination/pvr_device.h
Does anyone have any ideas why my invocation of htmldocs didn't seem to
have the same effect? Is it just simply that the relevant doc comment
isn't pulled into any of the rst docs; in which case how did the
linux-next build catch this warning?
Changes in v2:
- Add a proper commit description.
- Link to v1: https://lore.kernel.org/r/20251106-device-power-doc-fix-v1-1-76d9841c8084@imgtec.com
---
drivers/gpu/drm/imagination/pvr_device.h | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/drivers/gpu/drm/imagination/pvr_device.h b/drivers/gpu/drm/imagination/pvr_device.h
index ab8f56ae15df..ec53ff275541 100644
--- a/drivers/gpu/drm/imagination/pvr_device.h
+++ b/drivers/gpu/drm/imagination/pvr_device.h
@@ -146,6 +146,14 @@ struct pvr_device {
*/
struct clk *mem_clk;
+ /**
+ * @power: Optional power domain devices.
+ *
+ * On platforms with more than one power domain for the GPU, they are
+ * stored here in @domain_devs, along with links between them in
+ * @domain_links. The size of @domain_devs is given by @domain_count,
+ * while the size of @domain_links is (2 * @domain_count) - 1.
+ */
struct pvr_device_power {
struct device **domain_devs;
struct device_link **domain_links;
---
base-commit: cead55e24cf9e092890cf51c0548eccd7569defa
change-id: 20251106-device-power-doc-fix-ba1a5d753b6f
^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [PATCH v2] drm/imagination: Document pvr_device.power member
2025-11-21 15:20 [PATCH v2] drm/imagination: Document pvr_device.power member Matt Coster
@ 2025-11-21 16:43 ` Alessio Belle
2025-11-21 17:12 ` Matt Coster
` (2 subsequent siblings)
3 siblings, 0 replies; 5+ messages in thread
From: Alessio Belle @ 2025-11-21 16:43 UTC (permalink / raw)
To: Matt Coster
Cc: sfr@canb•auug.org.au, simona@ffwll•ch, linux-next@vger•kernel.org,
tzimmermann@suse•de, dri-devel@lists•freedesktop.org,
airlied@gmail•com, Frank Binns, maarten.lankhorst@linux•intel.com,
Alexandru Dadu, mripard@kernel•org, linux-kernel@vger•kernel.org
On Fri, 2025-11-21 at 15:20 +0000, Matt Coster wrote:
> Automated testing caught this missing doc comment; add something suitable
> (and useful).
>
> Fixes: 330e76d31697 ("drm/imagination: Add power domain control")
> Reported-by: Stephen Rothwell <sfr@canb•auug.org.au>
> Closes: https://lore.kernel.org/r/20251106152448.453b53ad@canb.auug.org.au/
> Signed-off-by: Matt Coster <matt.coster@imgtec•com>
Reviewed-by: Alessio Belle <alessio.belle@imgtec•com>
Thanks,
Alessio
> ---
> Based on the build target indicated in the report, I tried (and failed)
> to reproduce the reported warning using:
>
> make W=1 htmldocs
>
> I was, however, able to get the reported warning (and verify that this
> patch clears it) using:
>
> scripts/kernel-doc -none drivers/gpu/drm/imagination/pvr_device.h
>
> Does anyone have any ideas why my invocation of htmldocs didn't seem to
> have the same effect? Is it just simply that the relevant doc comment
> isn't pulled into any of the rst docs; in which case how did the
> linux-next build catch this warning?
>
> Changes in v2:
> - Add a proper commit description.
> - Link to v1: https://lore.kernel.org/r/20251106-device-power-doc-fix-v1-1-76d9841c8084@imgtec.com
> ---
> drivers/gpu/drm/imagination/pvr_device.h | 8 ++++++++
> 1 file changed, 8 insertions(+)
>
> diff --git a/drivers/gpu/drm/imagination/pvr_device.h b/drivers/gpu/drm/imagination/pvr_device.h
> index ab8f56ae15df..ec53ff275541 100644
> --- a/drivers/gpu/drm/imagination/pvr_device.h
> +++ b/drivers/gpu/drm/imagination/pvr_device.h
> @@ -146,6 +146,14 @@ struct pvr_device {
> */
> struct clk *mem_clk;
>
> + /**
> + * @power: Optional power domain devices.
> + *
> + * On platforms with more than one power domain for the GPU, they are
> + * stored here in @domain_devs, along with links between them in
> + * @domain_links. The size of @domain_devs is given by @domain_count,
> + * while the size of @domain_links is (2 * @domain_count) - 1.
> + */
> struct pvr_device_power {
> struct device **domain_devs;
> struct device_link **domain_links;
>
> ---
> base-commit: cead55e24cf9e092890cf51c0548eccd7569defa
> change-id: 20251106-device-power-doc-fix-ba1a5d753b6f
>
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH v2] drm/imagination: Document pvr_device.power member
2025-11-21 15:20 [PATCH v2] drm/imagination: Document pvr_device.power member Matt Coster
2025-11-21 16:43 ` Alessio Belle
@ 2025-11-21 17:12 ` Matt Coster
2025-11-22 0:29 ` Randy Dunlap
2025-11-22 3:46 ` Stephen Rothwell
3 siblings, 0 replies; 5+ messages in thread
From: Matt Coster @ 2025-11-21 17:12 UTC (permalink / raw)
To: Frank Binns, Alessio Belle, Alexandru Dadu, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
Matt Coster
Cc: Stephen Rothwell, dri-devel, linux-kernel, linux-next
On Fri, 21 Nov 2025 15:20:31 +0000, Matt Coster wrote:
> Automated testing caught this missing doc comment; add something suitable
> (and useful).
>
>
Applied, thanks!
[1/1] drm/imagination: Document pvr_device.power member
commit: 83c53f1a2d6c4c8c19354b926367d0e82dcd6386
Best regards,
--
Matt Coster <matt.coster@imgtec•com>
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH v2] drm/imagination: Document pvr_device.power member
2025-11-21 15:20 [PATCH v2] drm/imagination: Document pvr_device.power member Matt Coster
2025-11-21 16:43 ` Alessio Belle
2025-11-21 17:12 ` Matt Coster
@ 2025-11-22 0:29 ` Randy Dunlap
2025-11-22 3:46 ` Stephen Rothwell
3 siblings, 0 replies; 5+ messages in thread
From: Randy Dunlap @ 2025-11-22 0:29 UTC (permalink / raw)
To: Matt Coster, Frank Binns, Alessio Belle, Alexandru Dadu,
Maarten Lankhorst, Maxime Ripard, Thomas Zimmermann, David Airlie,
Simona Vetter
Cc: Stephen Rothwell, dri-devel, linux-kernel, linux-next
On 11/21/25 7:20 AM, Matt Coster wrote:
> Automated testing caught this missing doc comment; add something suitable
> (and useful).
>
> Fixes: 330e76d31697 ("drm/imagination: Add power domain control")
> Reported-by: Stephen Rothwell <sfr@canb•auug.org.au>
> Closes: https://lore.kernel.org/r/20251106152448.453b53ad@canb.auug.org.au/
> Signed-off-by: Matt Coster <matt.coster@imgtec•com>
> ---
> Based on the build target indicated in the report, I tried (and failed)
> to reproduce the reported warning using:
>
> make W=1 htmldocs
>
> I was, however, able to get the reported warning (and verify that this
> patch clears it) using:
>
> scripts/kernel-doc -none drivers/gpu/drm/imagination/pvr_device.h
>
> Does anyone have any ideas why my invocation of htmldocs didn't seem to
> have the same effect? Is it just simply that the relevant doc comment
> isn't pulled into any of the rst docs; in which case how did the
> linux-next build catch this warning?
Hi Matt,
I get the warnings when I run "make W=1 htmldocs" on the linux-next tree.
Are you using mainline (or close to it)? If so, it could be a difference in
scripts/kernel-doc.
The patch looks good. Thanks.
Acked-by: Randy Dunlap <rdunlap@infradead•org>
> Changes in v2:
> - Add a proper commit description.
> - Link to v1: https://lore.kernel.org/r/20251106-device-power-doc-fix-v1-1-76d9841c8084@imgtec.com
> ---
> drivers/gpu/drm/imagination/pvr_device.h | 8 ++++++++
> 1 file changed, 8 insertions(+)
>
> diff --git a/drivers/gpu/drm/imagination/pvr_device.h b/drivers/gpu/drm/imagination/pvr_device.h
> index ab8f56ae15df..ec53ff275541 100644
> --- a/drivers/gpu/drm/imagination/pvr_device.h
> +++ b/drivers/gpu/drm/imagination/pvr_device.h
> @@ -146,6 +146,14 @@ struct pvr_device {
> */
> struct clk *mem_clk;
>
> + /**
> + * @power: Optional power domain devices.
> + *
> + * On platforms with more than one power domain for the GPU, they are
> + * stored here in @domain_devs, along with links between them in
> + * @domain_links. The size of @domain_devs is given by @domain_count,
> + * while the size of @domain_links is (2 * @domain_count) - 1.
> + */
> struct pvr_device_power {
> struct device **domain_devs;
> struct device_link **domain_links;
>
> ---
> base-commit: cead55e24cf9e092890cf51c0548eccd7569defa
> change-id: 20251106-device-power-doc-fix-ba1a5d753b6f
>
>
--
~Randy
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH v2] drm/imagination: Document pvr_device.power member
2025-11-21 15:20 [PATCH v2] drm/imagination: Document pvr_device.power member Matt Coster
` (2 preceding siblings ...)
2025-11-22 0:29 ` Randy Dunlap
@ 2025-11-22 3:46 ` Stephen Rothwell
3 siblings, 0 replies; 5+ messages in thread
From: Stephen Rothwell @ 2025-11-22 3:46 UTC (permalink / raw)
To: Matt Coster
Cc: Frank Binns, Alessio Belle, Alexandru Dadu, Maarten Lankhorst,
Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter,
dri-devel, linux-kernel, linux-next
[-- Attachment #1: Type: text/plain, Size: 836 bytes --]
Hi Matt,
On Fri, 21 Nov 2025 15:20:31 +0000 Matt Coster <matt.coster@imgtec•com> wrote:
>
> Based on the build target indicated in the report, I tried (and failed)
> to reproduce the reported warning using:
>
> make W=1 htmldocs
>
> I was, however, able to get the reported warning (and verify that this
> patch clears it) using:
>
> scripts/kernel-doc -none drivers/gpu/drm/imagination/pvr_device.h
>
> Does anyone have any ideas why my invocation of htmldocs didn't seem to
> have the same effect? Is it just simply that the relevant doc comment
> isn't pulled into any of the rst docs; in which case how did the
> linux-next build catch this warning?
I just do "make htmldocs" on the final linux-next tree each day, so I
have no idea what makes a difference, sorry.
--
Cheers,
Stephen Rothwell
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 484 bytes --]
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2025-11-22 3:46 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-11-21 15:20 [PATCH v2] drm/imagination: Document pvr_device.power member Matt Coster
2025-11-21 16:43 ` Alessio Belle
2025-11-21 17:12 ` Matt Coster
2025-11-22 0:29 ` Randy Dunlap
2025-11-22 3:46 ` Stephen Rothwell
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox