[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
Also, fix minor typo.
Signed-off-by: Allan McRae
Hi Allan,
Just a couple of ideas:
On Fri, 8 Jan 2021 at 23:29, Allan McRae
Also, fix minor typo.
Signed-off-by: Allan McRae
--- 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
wrote: Also, fix minor typo.
Signed-off-by: Allan McRae
--- 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
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
wrote: Also, fix minor typo.
Signed-off-by: Allan McRae
--- 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
On Fri, 8 Jan 2021 at 23:29, Allan McRae
-/** \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
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