summaryrefslogtreecommitdiff
path: root/lib/libalpm/remove.c
diff options
context:
space:
mode:
authorRémy Oudompheng <remy@archlinux.org>2011-04-09 16:04:18 +0200
committerDan McGee <dan@archlinux.org>2011-04-09 15:24:11 -0500
commitff6f6027f09beaac9e387ca12f75583bba1dac21 (patch)
tree544eb17e2d925cc9505ece01182b8bb816031623 /lib/libalpm/remove.c
parenta479e0300baf48781d145e204e11a20059ad4caa (diff)
downloadpacman-ff6f6027f09beaac9e387ca12f75583bba1dac21.tar.xz
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>
Diffstat (limited to 'lib/libalpm/remove.c')
-rw-r--r--lib/libalpm/remove.c8
1 files changed, 8 insertions, 0 deletions
diff --git a/lib/libalpm/remove.c b/lib/libalpm/remove.c
index 5def92a6..7c8a99fb 100644
--- a/lib/libalpm/remove.c
+++ b/lib/libalpm/remove.c
@@ -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;