1
0
mirror of https://github.com/moparisthebest/pacman synced 2024-12-22 15:58:50 -05:00

Fix broken documentation for alpm_trans_prepare()

The current state of the code does not allow to see immediately
that it returns a list of pmdepmissing_t structures.

Signed-off-by: Dan McGee <dan@archlinux.org>
This commit is contained in:
Rémy Oudompheng 2011-04-09 16:04:18 +02:00 committed by Dan McGee
parent a479e0300b
commit ff6f6027f0
3 changed files with 11 additions and 3 deletions

View File

@ -261,7 +261,7 @@ pmpkg_t SYMEXPORT *alpm_find_satisfier(alpm_list_t *pkgs, const char *depstring)
* @param reversedeps handles the backward dependencies
* @param remove an alpm_list_t* of packages to be removed
* @param upgrade an alpm_list_t* of packages to be upgraded (remove-then-upgrade)
* @return an alpm_list_t* of pmpkg_t* of pmdepmissing_t pointers.
* @return an alpm_list_t* of pmdepmissing_t pointers.
*/
alpm_list_t SYMEXPORT *alpm_checkdeps(alpm_list_t *pkglist, int reversedeps,
alpm_list_t *remove, alpm_list_t *upgrade)

View File

@ -129,6 +129,14 @@ static void remove_prepare_keep_needed(pmtrans_t *trans, pmdb_t *db,
}
}
/** Transaction preparation for remove actions.
* This functions takes a pointer to a alpm_list_t which will be
* filled with a list of pmdepmissing_t* objects representing
* the packages blocking the transaction.
* @param trans the transaction object
* @param db the database of local packages
* @param data a pointer to an alpm_list_t* to fill
*/
int _alpm_remove_prepare(pmtrans_t *trans, pmdb_t *db, alpm_list_t **data)
{
alpm_list_t *lp;

View File

@ -177,8 +177,8 @@ static alpm_list_t *check_arch(alpm_list_t *pkgs)
}
/** Prepare a transaction.
* @param data the address of an alpm_list where detailed description
* of an error can be dumped (ie. list of conflicting files)
* @param data the address of an alpm_list where a list
* of pmdepmissing_t objects is dumped (conflicting packages)
* @return 0 on success, -1 on error (pm_errno is set accordingly)
*/
int SYMEXPORT alpm_trans_prepare(alpm_list_t **data)