[pacman-dev] [PATCH 1/3] doc: rename libalpm-list man page for consistency
All other libalpm man pages are in the form libalpm_<name>. Signed-off-by: Allan McRae <allan@archlinux.org> --- lib/libalpm/alpm_list.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/libalpm/alpm_list.h b/lib/libalpm/alpm_list.h index 5e75aa6e..a0299a70 100644 --- a/lib/libalpm/alpm_list.h +++ b/lib/libalpm/alpm_list.h @@ -34,7 +34,7 @@ extern "C" { /** * @ingroup libalpm - * @addtogroup libalpm-list libalpm-list(3) + * @addtogroup libalpm_list libalpm_list(3) * @brief Functions to manipulate alpm_list_t lists. * * These functions are designed to create, destroy, and modify lists of -- 2.30.0
Also, fix minor typo. Signed-off-by: Allan McRae <allan@archlinux.org> --- lib/libalpm/alpm.h | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/lib/libalpm/alpm.h b/lib/libalpm/alpm.h index 171cf740..69603b15 100644 --- a/lib/libalpm/alpm.h +++ b/lib/libalpm/alpm.h @@ -48,15 +48,20 @@ extern "C" { * * * - * libalpm is a package management library, primaraly used by + * libalpm is a package management library, primarily used by pacman. * For ease of access, the libalpm manual has been split up into several sections. * * @section see_also See Also * \b libalpm_list(3), - * \b alpm-hooks(5), - * \b makepkg(8), - * \b pacman(8), - * \b pacman.conf(5) + * \b libalpm_databases(3), + * \b libalpm_depends(3), + * \b libalpm_errors(3), + * \b libalpm_files(3), + * \b libalpm_groups(3), + * \b libalpm_options(3), + * \b libalpm_packages(3), + * \b libalpm_sig(3), + * \b libalpm_trans(3) * @{ */ -- 2.30.0
Hi Allan, Just a couple of ideas: On Fri, 8 Jan 2021 at 23:29, Allan McRae <allan@archlinux.org> wrote:
Also, fix minor typo.
Signed-off-by: Allan McRae <allan@archlinux.org> --- lib/libalpm/alpm.h | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-)
diff --git a/lib/libalpm/alpm.h b/lib/libalpm/alpm.h index 171cf740..69603b15 100644 --- a/lib/libalpm/alpm.h +++ b/lib/libalpm/alpm.h @@ -48,15 +48,20 @@ extern "C" { * * * - * libalpm is a package management library, primaraly used by + * libalpm is a package management library, primarily used by pacman. * For ease of access, the libalpm manual has been split up into several sections. * * @section see_also See Also * \b libalpm_list(3),
- * \b alpm-hooks(5), - * \b makepkg(8), - * \b pacman(8), - * \b pacman.conf(5) Might be worth splitting the removal ^^ or alternatively mention it in
Worth keeping this sorted in the libalpm list below? the commit message. HTH Emil
On 10/1/21 10:34 pm, Emil Velikov wrote:
Hi Allan,
Just a couple of ideas:
On Fri, 8 Jan 2021 at 23:29, Allan McRae <allan@archlinux.org> wrote:
Also, fix minor typo.
Signed-off-by: Allan McRae <allan@archlinux.org> --- lib/libalpm/alpm.h | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-)
diff --git a/lib/libalpm/alpm.h b/lib/libalpm/alpm.h index 171cf740..69603b15 100644 --- a/lib/libalpm/alpm.h +++ b/lib/libalpm/alpm.h @@ -48,15 +48,20 @@ extern "C" { * * * - * libalpm is a package management library, primaraly used by + * libalpm is a package management library, primarily used by pacman. * For ease of access, the libalpm manual has been split up into several sections. * * @section see_also See Also * \b libalpm_list(3),
Worth keeping this sorted in the libalpm list below?
I kept libalpm_list first, as it is a structure that is needed for almost everything else. I think this makes sense...
On Mon, 11 Jan 2021 at 01:15, Allan McRae <allan@archlinux.org> wrote:
On 10/1/21 10:34 pm, Emil Velikov wrote:
Hi Allan,
Just a couple of ideas:
On Fri, 8 Jan 2021 at 23:29, Allan McRae <allan@archlinux.org> wrote:
Also, fix minor typo.
Signed-off-by: Allan McRae <allan@archlinux.org> --- lib/libalpm/alpm.h | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-)
diff --git a/lib/libalpm/alpm.h b/lib/libalpm/alpm.h index 171cf740..69603b15 100644 --- a/lib/libalpm/alpm.h +++ b/lib/libalpm/alpm.h @@ -48,15 +48,20 @@ extern "C" { * * * - * libalpm is a package management library, primaraly used by + * libalpm is a package management library, primarily used by pacman. * For ease of access, the libalpm manual has been split up into several sections. * * @section see_also See Also * \b libalpm_list(3),
Worth keeping this sorted in the libalpm list below?
I kept libalpm_list first, as it is a structure that is needed for almost everything else. I think this makes sense...
I see it does. Fwiw without a separation (say a mini-heading for structs, functions) my brain goes into durp mode assuming the whole thing is alpha-sorted. Anywho, I'd call that an user issue ;-) HTH Emil
Signed-off-by: Allan McRae <allan@archlinux.org> --- lib/libalpm/alpm.h | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/lib/libalpm/alpm.h b/lib/libalpm/alpm.h index 69603b15..6433a225 100644 --- a/lib/libalpm/alpm.h +++ b/lib/libalpm/alpm.h @@ -53,11 +53,15 @@ extern "C" { * * @section see_also See Also * \b libalpm_list(3), + * \b libalpm_cb(3), * \b libalpm_databases(3), * \b libalpm_depends(3), * \b libalpm_errors(3), * \b libalpm_files(3), * \b libalpm_groups(3), + * \b libalpm_handle(3), + * \b libalpm_log(3), + * \b libalpm_misc(3), * \b libalpm_options(3), * \b libalpm_packages(3), * \b libalpm_sig(3), @@ -334,7 +338,7 @@ const char *alpm_strerror(alpm_errno_t err); /** @} */ -/** \addtogroup alpm_handle Handle +/** \addtogroup libalpm_handle Handle * @brief Functions to initialize and release libalpm * @{ */ @@ -707,7 +711,7 @@ void alpm_conflict_free(alpm_conflict_t *conflict); /** @} */ -/** \addtogroup alpm_cb Callbacks +/** \addtogroup libalpm_cb Callbacks * @brief Functions and structures for libalpm's callbacks * @{ */ @@ -1431,7 +1435,7 @@ int alpm_db_get_usage(alpm_db_t *db, int *usage); /** @} */ -/** \addtogroup alpm_log Logging Functions +/** \addtogroup libalpm_log Logging Functions * @brief Functions to log using libalpm * @{ */ @@ -2768,7 +2772,7 @@ int alpm_remove_pkg(alpm_handle_t *handle, alpm_pkg_t *pkg); /** @} */ -/** \addtogroup alpm_misc Miscellaneous Functions +/** \addtogroup libalpm_misc Miscellaneous Functions * @brief Various libalpm functions * @{ */ -- 2.30.0
On Fri, 8 Jan 2021 at 23:29, Allan McRae <allan@archlinux.org> wrote:
-/** \addtogroup alpm_handle Handle +/** \addtogroup libalpm_handle Handle
Might be worth updating the respective "End of alpm..." sections as well. As-is they are a bit misleading. HTH Emil
On 10/1/21 10:40 pm, Emil Velikov wrote:
On Fri, 8 Jan 2021 at 23:29, Allan McRae <allan@archlinux.org> wrote:
-/** \addtogroup alpm_handle Handle +/** \addtogroup libalpm_handle Handle
Might be worth updating the respective "End of alpm..." sections as well. As-is they are a bit misleading.
Thanks - now have adjusted all of this in the same patch. Allan
participants (2)
-
Allan McRae
-
Emil Velikov