drm/shmem-helper: Correct doc-comment of drm_gem_shmem_get_sg_table()
Subsystems (2)
PATCH 1/1 drm/shmem-helper: Correct doc-comment of drm_gem_shmem_get_sg_table()
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.
--- drivers/gpu/drm/drm_gem_shmem_helper.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/gpu/drm/drm_gem_shmem_helper.c +1 -1
@@ -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. */ struct sg_table *drm_gem_shmem_get_sg_table (struct drm_gem_shmem_object *shmem) {
Signature · 1 line
2.35.1
Quoted 13 lines · Dmitry Osipenko
drm_gem_shmem_get_sg_table()never returns NULL on error, but aERR_PTR. Correct the doc comment which says that it returns NULL on error.Signed-off-by Dmitry Osipenko <[email protected]>--- drivers/gpu/drm/drm_gem_shmem_helper.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)drivers/gpu/drm/drm_gem_shmem_helper.c +0
-0
drivers/gpu/drm/drm_gem_shmem_helper.c EXPORT_SYMBOL(drm_gem_shmem_print_info); · line 665
Quoted 5 lines
drivers/gpu/drm/drm_gem_shmem_helper.c +1
-1@@ -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?
Thanks a lot, Daniel
Quoted 6 lines
drivers/gpu/drm/drm_gem_shmem_helper.c +0
-0*/ struct sg_table *drm_gem_shmem_get_sg_table (struct drm_gem_shmem_object *shmem) {Signature · 1 line
2.35.1
Signature · 3 lines
Daniel Vetter Software Engineer, Intel Corporation http://blog.ffwll.ch
Quoted 9 lines · Daniel Vetter
Quoted 8 lines · Dmitry Osipenko
drm_gem_shmem_get_sg_table()never returns NULL on error, but aERR_PTR. Correct the doc comment which says that it returns NULL on error.Signed-off-by Dmitry Osipenko <[email protected]>--- drivers/gpu/drm/drm_gem_shmem_helper.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Quoted 13 lines
drivers/gpu/drm/drm_gem_shmem_helper.c EXPORT_SYMBOL(drm_gem_shmem_print_info); · line 665
Quoted 10 lines
drivers/gpu/drm/drm_gem_shmem_helper.c +1
-1@@ -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.