From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from fanzine2.igalia.com (fanzine.igalia.com [178.60.130.6]) by gabe.freedesktop.org (Postfix) with ESMTPS id 2327D10E0E1 for ; Tue, 26 Dec 2023 19:11:43 +0000 (UTC) From: Melissa Wen To: igt-dev@lists.freedesktop.org, Petri Latvala , Arkadiusz Hiler , Kamil Konieczny , Bhanuprakash Modem , Ashutosh Dixit , Juha-Pekka Heikkila 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 Message-ID: <20231226191054.23794-3-mwen@igalia.com> In-Reply-To: <20231226191054.23794-1-mwen@igalia.com> References: <20231226191054.23794-1-mwen@igalia.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: kernel-dev@igalia.com, Arun R Murthy Errors-To: igt-dev-bounces@lists.freedesktop.org Sender: "igt-dev" List-ID: 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 --- 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