[PATCH i-g-t 2/3] lib/igt_fb: fix documentation of igt_create_color_fb return

Melissa Wen mwen at igalia.com
Tue Dec 26 18:57:33 UTC 2023


igt_create_fb fails without returning a negative error code (unsigned
int), so does igt_create_color_fb. Remove the `negative error code on
failure` from function docs to avoid misleading usage.

Signed-off-by: Melissa Wen <mwen at igalia.com>
---
 lib/igt_fb.c | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/lib/igt_fb.c b/lib/igt_fb.c
index 2cf94013e..2446edd2b 100644
--- a/lib/igt_fb.c
+++ b/lib/igt_fb.c
@@ -2174,8 +2174,7 @@ unsigned int igt_create_fb(int fd, int width, int height, uint32_t format,
  * with the given color, which is useful for some simple pipe crc based tests.
  *
  * Returns:
- * The kms id of the created framebuffer on success or a negative error code on
- * failure.
+ * The kms id of the created framebuffer on success.
  */
 unsigned int igt_create_color_fb(int fd, int width, int height,
 				 uint32_t format, uint64_t modifier,
-- 
2.43.0



More information about the igt-dev mailing list