linux-kernel - Re: [PATCH] drm: Fix missing kernel-doc parameter descriptions in drm_gem_shmem

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: Windows password security audit tool. GUI, reports in PDF.

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

Message-ID: <6b9fbe75-146f-4668-8fce-5cda39f0daf7@suse.de>
Date: Fri, 14 Nov 2025 08:34:53 +0100
From: Thomas Zimmermann <tzimmermann@...e.de>
To: Kriish Sharma <kriish.sharma2006@...il.com>,
 maarten.lankhorst@...ux.intel.com, mripard@...nel.org, airlied@...il.com,
 simona@...ll.ch
Cc: dri-devel@...ts.freedesktop.org, linux-kernel@...r.kernel.org,
 lkp@...el.com
Subject: Re: [PATCH] drm: Fix missing kernel-doc parameter descriptions in
 drm_gem_shmem_init()



Am 14.11.25 um 08:27 schrieb Kriish Sharma:
> The kernel test robot reported missing parameter documentation in
> drm_gem_shmem_init(), triggering warnings during documentation builds:
>
> WARNING: ./drivers/gpu/drm/drm_gem_shmem_helper.c:104 function parameter 'shmem' not described in 'drm_gem_shmem_init'
> WARNING: ./drivers/gpu/drm/drm_gem_shmem_helper.c:104 function parameter 'size' not described in 'drm_gem_shmem_init'
>
> Add missing @shmem and @size descriptions to fix the kernel-doc issues
> and ensure the documentation is complete
>
> Fixes: e3f4bdaf2c5b ("drm/gem/shmem: Extract drm_gem_shmem_init() from drm_gem_shmem_create()")
> Reported-by: kernel test robot <lkp@...el.com>
> Closes: https://lore.kernel.org/oe-kbuild-all/202508040518.ZISc9nPg-lkp@intel.com
> Signed-off-by: Kriish Sharma <kriish.sharma2006@...il.com>

Reviewed-by: Thomas Zimmermann <tzimmermann@...e.de>

> ---
>   drivers/gpu/drm/drm_gem_shmem_helper.c | 3 ++-
>   1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/drivers/gpu/drm/drm_gem_shmem_helper.c b/drivers/gpu/drm/drm_gem_shmem_helper.c
> index dc94a27710e5..1d1e8add99c9 100644
> --- a/drivers/gpu/drm/drm_gem_shmem_helper.c
> +++ b/drivers/gpu/drm/drm_gem_shmem_helper.c
> @@ -96,7 +96,8 @@ static int __drm_gem_shmem_init(struct drm_device *dev, struct drm_gem_shmem_obj
>   /**
>    * drm_gem_shmem_init - Initialize an allocated object.
>    * @dev: DRM device
> - * @obj: The allocated shmem GEM object.
> + * @shmem: shmem GEM object
> + * @size: Size of the object to initialize
>    *
>    * Returns:
>    * 0 on success, or a negative error code on failure.

-- 
--
Thomas Zimmermann
Graphics Driver Developer
SUSE Software Solutions Germany GmbH
Frankenstr. 146, 90461 Nürnberg, Germany, www.suse.com
GF: Jochen Jaser, Andrew McDonald, Werner Knoblich, (HRB 36809, AG Nürnberg)