Re: [PATCH 1/3] drm/imagination: fixup some docs in pvr_gem.h

Alessio Belle <[email protected]>
Newsgroups gmane.linux.kernel,gmane.comp.video.dri.devel
Message-ID <[email protected]>
On Mon, 2026-08-03 at 11:22 +0100, Luigi Santivetti wrote:
> From: Matt Coster <[email protected]>
> 
> Update and remove some old comment in the PVR gem documentation.

nit: comment -> comments, maybe gem -> GEM

> 
> Signed-off-by: Matt Coster <[email protected]>
> Signed-off-by: Luigi Santivetti <[email protected]>
> ---
>  drivers/gpu/drm/imagination/pvr_gem.h | 15 +++++----------
>  1 file changed, 5 insertions(+), 10 deletions(-)
> 
> diff --git a/drivers/gpu/drm/imagination/pvr_gem.h b/drivers/gpu/drm/imagination/pvr_gem.h
> index c99f30cc6208..c57b0834b7ae 100644
> --- a/drivers/gpu/drm/imagination/pvr_gem.h
> +++ b/drivers/gpu/drm/imagination/pvr_gem.h
> @@ -81,11 +81,12 @@ struct pvr_file;
>   * struct pvr_gem_object - powervr-specific wrapper for &struct drm_gem_object
>   */
>  struct pvr_gem_object {
> -	/**
> -	 * @base: The underlying &struct drm_gem_shmem_object.
> +	/** @base: The underlying &struct drm_gem_shmem_object.

This was correct before, on its own line (kernel-doc is throwing a warning).

With this updated,

Reviewed-by: Alessio Belle <[email protected]>

Thanks,
Alessio

> +	 *
> +	 * .. note::
>  	 *
> -	 * Do not access this member directly, instead call
> -	 * shem_gem_from_pvr_gem().
> +	 *    This member should not be accessed directly, but instead by
> +	 *    calling shmem_gem_from_pvr_gem().
>  	 */
>  	struct drm_gem_shmem_object base;
>  
> @@ -97,12 +98,6 @@ struct pvr_gem_object {
>  	 * changed after creation.
>  	 *
>  	 * Must be a combination of DRM_PVR_BO_* and/or PVR_BO_* flags.
> -	 *
> -	 * .. note::
> -	 *
> -	 *    This member is declared const to indicate that none of these
> -	 *    options may change or be changed throughout the object's
> -	 *    lifetime.
>  	 */
>  	u64 flags;
>  
>
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.