[pacman-dev] [PATCH] Add detailed description to alpm_pkg_load

[Sebastian Nowicki]

It was unclear what "loading the full package" actually did. The
detailed description should clear that up, without having to look at the
code.

Signed-off-by: Sebastian Nowicki <sebnow at gmail.com>
---
 lib/libalpm/package.c |    3 +++
 1 files changed, 3 insertions(+), 0 deletions(-)

diff --git a/lib/libalpm/package.c b/lib/libalpm/package.c
index ffaa96b..32ff3a8 100644
--- a/lib/libalpm/package.c
+++ b/lib/libalpm/package.c
@@ -54,6 +54,9 @@
  */
 
 /** Create a package from a file.
+ * If full is false, the archive is read only until all necessary
+ * metadata is found. If it is true, the entire archive is read, which
+ * serves as a verfication of integrity and the filelist can be created.
  * @param filename location of the package tarball
  * @param full whether to stop the load after metadata is read or continue
  *             through the full archive
-- 
1.5.4.5