diff mbox series

[pacman-dev,v2] alpm: fix documentation for alpm_mtree_next

Message ID 20191120004647.65061-1-morganamilo@archlinux.org
State Superseded, archived
Headers show
Series [pacman-dev,v2] alpm: fix documentation for alpm_mtree_next | expand

Commit Message

morganamilo Nov. 20, 2019, 12:46 a.m. UTC 
End of archive is 1, not 0, also it is possible for errors to occur.

Signed-off-by: morganamilo <morganamilo@archlinux.org>

---

V2: fix stray changes. Working dir was not clean....
diff mbox series

Patch

diff --git a/lib/libalpm/alpm.h b/lib/libalpm/alpm.h
index d3630385..9c474443 100644
--- a/lib/libalpm/alpm.h
+++ b/lib/libalpm/alpm.h
@@ -1328,7 +1328,7 @@  struct archive *alpm_pkg_mtree_open(alpm_pkg_t *pkg);
  * @param pkg the package that the mtree file is being read from
  * @param archive the archive structure reading from the mtree file
  * @param entry an archive_entry to store the entry header information
- * @return 0 if end of archive is reached, non-zero otherwise.
+ * @return 1 if end of archive is reached, 0 on success, otherwise error
  */
 int alpm_pkg_mtree_next(const alpm_pkg_t *pkg, struct archive *archive,
 		struct archive_entry **entry);