[pacman-dev,1/4] libalpm: fix incorrect documentation

Message ID 20190908214529.3512-1-morganamilo@gmail.com
State Accepted, archived
Headers show
Series
  • [pacman-dev,1/4] libalpm: fix incorrect documentation
Related show

Commit Message

morganamilo Sept. 8, 2019, 9:45 p.m. UTC
---
 lib/libalpm/deps.c | 12 +++++++-----
 1 file changed, 7 insertions(+), 5 deletions(-)

Comments

Allan McRae Oct. 7, 2019, 4:20 a.m. UTC | #1
On 9/9/19 7:45 am, morganamilo wrote:
> ---
>  lib/libalpm/deps.c | 12 +++++++-----
>  1 file changed, 7 insertions(+), 5 deletions(-)
> 

Changes look fine.

A

> diff --git a/lib/libalpm/deps.c b/lib/libalpm/deps.c
> index 71185c68..ce7869c3 100644
> --- a/lib/libalpm/deps.c
> +++ b/lib/libalpm/deps.c
> @@ -643,10 +643,9 @@ int _alpm_recursedeps(alpm_db_t *db, alpm_list_t **targs, int include_explicit)
>   * @param dep is the dependency to search for
>   * @param dbs are the databases to search
>   * @param excluding are the packages to exclude from the search
> - * @param prompt if true, will cause an unresolvable dependency to issue an
> - *        interactive prompt asking whether the package should be removed from
> - *        the transaction or the transaction aborted; if false, simply returns
> - *        an error code without prompting
> + * @param prompt if true, ask an alpm_question_install_ignorepkg_t to decide
> + *        if ignored packages should be installed; if false, skip ignored
> + *        packages.
>   * @return the resolved package
>   **/
>  static alpm_pkg_t *resolvedep(alpm_handle_t *handle, alpm_depend_t *dep,
> @@ -766,8 +765,11 @@ static alpm_pkg_t *resolvedep(alpm_handle_t *handle, alpm_depend_t *dep,
>  
>  /** Find a package satisfying a specified dependency.
>   * First look for a literal, going through each db one by one. Then look for
> - * providers. The first satisfier found is returned.
> + * providers. The first satisfier that belongs to an installed package is
> + * returned. If no providers belong to an installed package then an
> + * alpm_question_select_provider_t is created to select the provider.
>   * The dependency can include versions with depmod operators.
> + *
>   * @param handle the context handle
>   * @param dbs an alpm_list_t* of alpm_db_t where the satisfier will be searched
>   * @param depstring package or provision name, versioned or not
>

Patch

diff --git a/lib/libalpm/deps.c b/lib/libalpm/deps.c
index 71185c68..ce7869c3 100644
--- a/lib/libalpm/deps.c
+++ b/lib/libalpm/deps.c
@@ -643,10 +643,9 @@  int _alpm_recursedeps(alpm_db_t *db, alpm_list_t **targs, int include_explicit)
  * @param dep is the dependency to search for
  * @param dbs are the databases to search
  * @param excluding are the packages to exclude from the search
- * @param prompt if true, will cause an unresolvable dependency to issue an
- *        interactive prompt asking whether the package should be removed from
- *        the transaction or the transaction aborted; if false, simply returns
- *        an error code without prompting
+ * @param prompt if true, ask an alpm_question_install_ignorepkg_t to decide
+ *        if ignored packages should be installed; if false, skip ignored
+ *        packages.
  * @return the resolved package
  **/
 static alpm_pkg_t *resolvedep(alpm_handle_t *handle, alpm_depend_t *dep,
@@ -766,8 +765,11 @@  static alpm_pkg_t *resolvedep(alpm_handle_t *handle, alpm_depend_t *dep,
 
 /** Find a package satisfying a specified dependency.
  * First look for a literal, going through each db one by one. Then look for
- * providers. The first satisfier found is returned.
+ * providers. The first satisfier that belongs to an installed package is
+ * returned. If no providers belong to an installed package then an
+ * alpm_question_select_provider_t is created to select the provider.
  * The dependency can include versions with depmod operators.
+ *
  * @param handle the context handle
  * @param dbs an alpm_list_t* of alpm_db_t where the satisfier will be searched
  * @param depstring package or provision name, versioned or not