diff mbox series

[pacman-dev] Improved documentation for alpm_db_search() parameters

Message ID 20191121233558.418977-1-allan@archlinux.org
State Accepted, archived
Headers show
Series [pacman-dev] Improved documentation for alpm_db_search() parameters | expand

Commit Message

Allan McRae Nov. 21, 2019, 11:35 p.m. UTC 
Signed-off-by: Allan McRae <allan@archlinux.org>
---
 lib/libalpm/alpm.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
diff mbox series

Patch

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,