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>
This commit is contained in:
Sebastian Nowicki 2008-05-11 03:15:36 +08:00 committed by Dan McGee
parent 27943a04d6
commit e3d35b3274
1 changed files with 3 additions and 0 deletions

View File

@ -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