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

[Kamil Konieczny]

Hi Melissa,
On 2023-12-26 at 17:57:33 -0100, Melissa Wen wrote:
> 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.

Why not just make it correct?

int igt_create_color_fb(int fd, int width, int height,

and check for errors and return -errno or what is received.

Regards,
Kamil

> 
> 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
>