Add detailed description to alpm_pkg_load

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@gmail.com>
Signed-off-by: Dan McGee <dan@archlinux.org>

1 files changed, 3 insertions, 0 deletions

diff --git a/lib/libalpm/package.c b/lib/libalpm/package.c
index 287c2ce4..794a2f7d 100644
--- a/lib/libalpm/package.c
+++ b/lib/libalpm/package.c
@@ -55,6 +55,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