linux-kernel - Re: [PATCH] drm/vram-helper: fix typos in vram helper doc

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: <4a44a2a9-e78b-06e6-f3fb-f4bb7b09cd94@suse.de>
Date:   Mon, 27 Feb 2023 14:13:16 +0100
From:   Thomas Zimmermann <tzimmermann@...e.de>
To:     Luc Ma <onion0709@...il.com>,
        Maarten Lankhorst <maarten.lankhorst@...ux.intel.com>,
        Maxime Ripard <mripard@...nel.org>,
        David Airlie <airlied@...il.com>,
        Daniel Vetter <daniel@...ll.ch>,
        Sam Ravnborg <sam@...nborg.org>,
        dri-devel@...ts.freedesktop.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] drm/vram-helper: fix typos in vram helper doc

Hi

thanks for the fix. A few things could be improved.

The subject line should say 'fix function names' instead of 'fix typos'. 
The patch also deserves at least a minimal description if the change. 
Something like 'Refer to drmm_vram_helper_init() instead of the 
non-existent drmm_vram_helper_alloc_mm().' If someone later searches the 
git history for such changes, it's helpful to have the function names 
mentioned.

Best regards
Thomas

Am 27.02.23 um 13:38 schrieb Luc Ma:
> Fixes: a5f23a72355d ("drm/vram-helper: Managed vram helpers")
> Signed-off-by: Luc Ma <luc@...tium.com>
> ---
>   drivers/gpu/drm/drm_gem_vram_helper.c | 6 +++---
>   1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/drivers/gpu/drm/drm_gem_vram_helper.c b/drivers/gpu/drm/drm_gem_vram_helper.c
> index d40b3edb52d0..f1539d4448c6 100644
> --- a/drivers/gpu/drm/drm_gem_vram_helper.c
> +++ b/drivers/gpu/drm/drm_gem_vram_helper.c
> @@ -45,7 +45,7 @@ static const struct drm_gem_object_funcs drm_gem_vram_object_funcs;
>    * the frame's scanout buffer or the cursor image. If there's no more space
>    * left in VRAM, inactive GEM objects can be moved to system memory.
>    *
> - * To initialize the VRAM helper library call drmm_vram_helper_alloc_mm().
> + * To initialize the VRAM helper library call drmm_vram_helper_init().
>    * The function allocates and initializes an instance of &struct drm_vram_mm
>    * in &struct drm_device.vram_mm . Use &DRM_GEM_VRAM_DRIVER to initialize
>    * &struct drm_driver and  &DRM_VRAM_MM_FILE_OPERATIONS to initialize
> @@ -73,7 +73,7 @@ static const struct drm_gem_object_funcs drm_gem_vram_object_funcs;
>    *		// setup device, vram base and size
>    *		// ...
>    *
> - *		ret = drmm_vram_helper_alloc_mm(dev, vram_base, vram_size);
> + *		ret = drmm_vram_helper_init(dev, vram_base, vram_size);
>    *		if (ret)
>    *			return ret;
>    *		return 0;
> @@ -86,7 +86,7 @@ static const struct drm_gem_object_funcs drm_gem_vram_object_funcs;
>    * to userspace.
>    *
>    * You don't have to clean up the instance of VRAM MM.
> - * drmm_vram_helper_alloc_mm() is a managed interface that installs a
> + * drmm_vram_helper_init() is a managed interface that installs a
>    * clean-up handler to run during the DRM device's release.
>    *
>    * For drawing or scanout operations, rsp. buffer objects have to be pinned

-- 
Thomas Zimmermann
Graphics Driver Developer
SUSE Software Solutions Germany GmbH
Maxfeldstr. 5, 90409 Nürnberg, Germany
(HRB 36809, AG Nürnberg)
Geschäftsführer: Ivo Totev

Download attachment "OpenPGP_signature" of type "application/pgp-signature" (841 bytes)