From 55233b69c74a087ff405d3f768e5303dacaf8129 Mon Sep 17 00:00:00 2001 From: Allan McRae Date: Fri, 22 Nov 2019 09:35:31 +1000 Subject: Improved documentation for alpm_db_search() parameters Signed-off-by: Allan McRae --- lib/libalpm/alpm.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) 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, -- cgit v1.2.3-24-g4f1b