summaryrefslogtreecommitdiffstats
path: root/lib/libalpm/trans.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 22:24:11 +0200
commitff6f6027f09beaac9e387ca12f75583bba1dac21 (patch)
tree544eb17e2d925cc9505ece01182b8bb816031623 /lib/libalpm/trans.c
parenta479e0300baf48781d145e204e11a20059ad4caa (diff)
downloadpacman-ff6f6027f09beaac9e387ca12f75583bba1dac21.tar.gz
pacman-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/trans.c')
-rw-r--r--lib/libalpm/trans.c4
1 files changed, 2 insertions, 2 deletions
diff --git a/lib/libalpm/trans.c b/lib/libalpm/trans.c
index 08856d07..309a56a3 100644
--- a/lib/libalpm/trans.c
+++ b/lib/libalpm/trans.c
@@ -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)