From: Melissa Wen <mwen@igalia.com>
To: igt-dev@lists.freedesktop.org,
Petri Latvala <adrinael@adrinael.net>,
Arkadiusz Hiler <arek@hiler.eu>,
Kamil Konieczny <kamil.konieczny@linux.intel.com>,
Bhanuprakash Modem <bhanuprakash.modem@intel.com>,
Ashutosh Dixit <ashutosh.dixit@intel.com>,
Juha-Pekka Heikkila <juhapekka.heikkila@gmail.com>
Cc: kernel-dev@igalia.com, Arun R Murthy <arun.r.murthy@intel.com>
Subject: [PATCH i-g-t 2/3] lib/igt_fb: fix documentation of igt_create_color_fb return
Date: Tue, 26 Dec 2023 17:57:33 -0100 [thread overview]
Message-ID: <20231226191054.23794-3-mwen@igalia.com> (raw)
In-Reply-To: <20231226191054.23794-1-mwen@igalia.com>
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@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
next prev parent reply other threads:[~2023-12-26 19:11 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-12-26 18:57 [PATCH i-g-t 0/3] test/kms_async_flip: fixes to get execution Melissa Wen
2023-12-26 18:57 ` [PATCH i-g-t 1/3] test/kms_async_flips: fix test abortion due to unreadable mod name Melissa Wen
2024-01-04 18:22 ` Kamil Konieczny
2023-12-26 18:57 ` Melissa Wen [this message]
2024-01-04 18:24 ` [PATCH i-g-t 2/3] lib/igt_fb: fix documentation of igt_create_color_fb return Kamil Konieczny
2024-01-05 11:56 ` Melissa Wen
2023-12-26 18:57 ` [PATCH i-g-t 3/3] tests/kms_async_flips: test with modifiers only on intel devices Melissa Wen
2024-01-04 18:25 ` Kamil Konieczny
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20231226191054.23794-3-mwen@igalia.com \
--to=mwen@igalia.com \
--cc=adrinael@adrinael.net \
--cc=arek@hiler.eu \
--cc=arun.r.murthy@intel.com \
--cc=ashutosh.dixit@intel.com \
--cc=bhanuprakash.modem@intel.com \
--cc=igt-dev@lists.freedesktop.org \
--cc=juhapekka.heikkila@gmail.com \
--cc=kamil.konieczny@linux.intel.com \
--cc=kernel-dev@igalia.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox