Re: [PATCH v4 09/15] drm/shmem-helper: Correct doc-comment of drm_gem_shmem_get_sg_table()

Thomas Zimmermann
2022-04-18T18:25:48Z

[-- Attachment #1.1: Type: text/plain, Size: 1851 bytes --]

Hi

Am 18.04.22 um 00:37 schrieb Dmitry Osipenko:
> drm_gem_shmem_get_sg_table() never returns NULL on error, but a ERR_PTR.
> Correct the doc comment which says that it returns NULL on error.
>
> Signed-off-by: Dmitry Osipenko <dmitry.osipenko@collabora.com>

> ---
> drivers/gpu/drm/drm_gem_shmem_helper.c | 5 +++--
> 1 file changed, 3 insertions(+), 2 deletions(-)
>
> diff --git a/drivers/gpu/drm/drm_gem_shmem_helper.c b/drivers/gpu/drm/drm_gem_shmem_helper.c
> index 8ad0e02991ca..30ee46348a99 100644
> --- a/drivers/gpu/drm/drm_gem_shmem_helper.c
> +++ b/drivers/gpu/drm/drm_gem_shmem_helper.c
> @@ -662,7 +662,7 @@ EXPORT_SYMBOL(drm_gem_shmem_print_info);
> * drm_gem_shmem_get_pages_sgt() instead.
> *
> * Returns:
> - * A pointer to the scatter/gather table of pinned pages or NULL on failure.
> + * A pointer to the scatter/gather table of pinned pages or errno on failure.

', or an ERR_PTR()-encoded errno code on failure'

> */
> struct sg_table *drm_gem_shmem_get_sg_table(struct drm_gem_shmem_object *shmem)
> {
> @@ -688,7 +688,8 @@ EXPORT_SYMBOL_GPL(drm_gem_shmem_get_sg_table);
> * drm_gem_shmem_get_sg_table() should not be directly called by drivers.
> *
> * Returns:
> - * A pointer to the scatter/gather table of pinned pages or errno on failure.
> + * A pointer to the scatter/gather table of pinned pages ERR_PTR()-encoded

', or an' before ERR_PTR

With the improved grammar:

Acked-by: Thomas Zimmermann <tzimmermann@suse.de>

> + * error code on failure.
> */
> struct sg_table *drm_gem_shmem_get_pages_sgt(struct drm_gem_shmem_object *shmem)
> {

--
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

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 840 bytes --]