From 6a2e856ff2d06c0313bf9527ac8b8697814f37b1 Mon Sep 17 00:00:00 2001 From: Enno Boland Date: Sat, 2 Sep 2023 22:47:36 +0200 Subject: [PATCH] include: fix documentation for sqsh_inode_map_get() The documentation for sqsh_inode_map_get() stated, that the function returns a negative error code on failure. The implementation however returns 0 on error. Inodes are always > 0, so using 0 as error code is safe. --- include/sqsh_archive.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/sqsh_archive.h b/include/sqsh_archive.h index e1095586a..f043a1116 100644 --- a/include/sqsh_archive.h +++ b/include/sqsh_archive.h @@ -84,7 +84,7 @@ const uint8_t *sqsh_trailing_data(const struct SqshTrailingContext *context); * @param[in] map The context to use. * @param[in] inode_number The inode number to get the reference for. * - * @return The inode reference on success, a negative value on error. + * @return The inode reference on success, 0 on error. */ SQSH_NO_UNUSED uint64_t sqsh_inode_map_get(const struct SqshInodeMap *map, uint64_t inode_number);