[PATCH v1] drm/shmem-helper: Correct doc-comment of drm_gem_shmem_get_sg_table()

[Dmitry Osipenko]

On 3/17/22 12:52, Daniel Vetter wrote:
> On Tue, Mar 08, 2022 at 04:34:01PM +0300, Dmitry Osipenko wrote:
>> 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 at collabora.com>
>> ---
>>  drivers/gpu/drm/drm_gem_shmem_helper.c | 2 +-
>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/drivers/gpu/drm/drm_gem_shmem_helper.c b/drivers/gpu/drm/drm_gem_shmem_helper.c
>> index 8ad0e02991ca..37009418cd28 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.
> 
> Hm usually we write "negative errno" for these, since the error numbers
> are defined as positive numbers. Care to respin?

It's actually ERR_PTR that is returned here, "errno" was borrowed from
some other similar DRM comment. I added this patch to v2 of virtio
patchset [1] and will improve the comment in v3, thanks.

[1]
https://lore.kernel.org/dri-devel/20220314224253.236359-1-dmitry.osipenko@collabora.com/T/#t