linux-kernel - Re: [PATCH v2] drm/imagination: Document pvr

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <1022b551-ad51-4eed-bd75-a5865bd8d466@infradead.org>
Date: Fri, 21 Nov 2025 16:29:48 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: Matt Coster <matt.coster@...tec.com>, Frank Binns
 <frank.binns@...tec.com>, Alessio Belle <alessio.belle@...tec.com>,
 Alexandru Dadu <alexandru.dadu@...tec.com>,
 Maarten Lankhorst <maarten.lankhorst@...ux.intel.com>,
 Maxime Ripard <mripard@...nel.org>, Thomas Zimmermann <tzimmermann@...e.de>,
 David Airlie <airlied@...il.com>, Simona Vetter <simona@...ll.ch>
Cc: Stephen Rothwell <sfr@...b.auug.org.au>, dri-devel@...ts.freedesktop.org,
 linux-kernel@...r.kernel.org, linux-next@...r.kernel.org
Subject: Re: [PATCH v2] drm/imagination: Document pvr_device.power member



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@...b.auug.org.au>
> Closes: https://lore.kernel.org/r/20251106152448.453b53ad@canb.auug.org.au/
> Signed-off-by: Matt Coster <matt.coster@...tec.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@...radead.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