]> git.ipfire.org Git - thirdparty/xz.git/commitdiff
xz: Fix comments
authorLasse Collin <lasse.collin@tukaani.org>
Thu, 26 Dec 2024 19:27:18 +0000 (21:27 +0200)
committerLasse Collin <lasse.collin@tukaani.org>
Fri, 27 Dec 2024 07:15:33 +0000 (09:15 +0200)
(cherry picked from commit 260d5d36203955a7148ae1ab05d0931c942028d5)

src/xz/file_io.c
src/xz/file_io.h

index 678a9a5ca8604a9a829c2a5ec740b07c8da196df..7a7365f18f03c945bcf06f2c6d5059c545a81b95 100644 (file)
@@ -979,8 +979,8 @@ io_open_dest(file_pair *pair)
 /// \param      pair    File whose dest_fd should be closed
 /// \param      success If false, the file will be removed from the disk.
 ///
-/// \return     Zero if closing succeeds. On error, -1 is returned and
-///             error message printed.
+/// \return     If closing succeeds, false is returned. On error, an error
+///             message is printed and true is returned.
 static bool
 io_close_dest(file_pair *pair, bool success)
 {
index ae7e2f38f52086239bc1637bb2bfb37c89b21b61..f7b2f49e637549ce80a79220ff85f85dda1ad67e 100644 (file)
@@ -177,6 +177,6 @@ extern bool io_pread(file_pair *pair, io_buf *buf, size_t size, uint64_t pos);
 /// \param      buf     Buffer containing the data to be written
 /// \param      size    Size of the buffer; must be at most IO_BUFFER_SIZE
 ///
-/// \return     On success, zero is returned. On error, -1 is returned
-///             and error message printed.
+/// \return     On success, false is returned. On error, error message
+///             is printed and true is returned.
 extern bool io_write(file_pair *pair, const io_buf *buf, size_t size);