summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAllan McRae <allan@archlinux.org>2019-11-22 00:35:31 +0100
committerAllan McRae <allan@archlinux.org>2019-11-22 00:35:31 +0100
commit55233b69c74a087ff405d3f768e5303dacaf8129 (patch)
tree52b12089cf2a0c313052f753837f793e68e67048
parent8846574eda51cb48b3c3a462abb8bb9b61b7e10b (diff)
downloadpacman-55233b69c74a087ff405d3f768e5303dacaf8129.tar.gz
pacman-55233b69c74a087ff405d3f768e5303dacaf8129.tar.xz
Improved documentation for alpm_db_search() parameters
Signed-off-by: Allan McRae <allan@archlinux.org>
-rw-r--r--lib/libalpm/alpm.h3
1 files changed, 2 insertions, 1 deletions
diff --git a/lib/libalpm/alpm.h b/lib/libalpm/alpm.h
index d3630385..c200a5d8 100644
--- a/lib/libalpm/alpm.h
+++ b/lib/libalpm/alpm.h
@@ -997,7 +997,8 @@ alpm_list_t *alpm_db_get_groupcache(alpm_db_t *db);
/** Searches a database with regular expressions.
* @param db pointer to the package database to search in
* @param needles a list of regular expressions to search for
- * @param ret the list of packages matching all regular expressions
+ * @param ret pointer to list for storing packages matching all
+ * regular expressions - must point to an empty (NULL) alpm_list_t *.
* @return 0 on success, -1 on error (pm_errno is set accordingly)
*/
int alpm_db_search(alpm_db_t *db, const alpm_list_t *needles,