From patchwork Mon Dec 7 22:19:55 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: morganamilo X-Patchwork-Id: 1817 Return-Path: Delivered-To: patchwork@archlinux.org Received: from apollo.archlinux.org (localhost [127.0.0.1]) by apollo.archlinux.org (Postfix) with ESMTP id 692C81C996DB2 for ; Mon, 7 Dec 2020 22:31:40 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on apollo.archlinux.org X-Spam-Level: X-Spam-Status: No, score=-0.6 required=5.0 tests=DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1,DKIM_VALID=-0.1,DKIM_VALID_AU=-0.1, LOCAL_FAKEBUSINESS=0.5,MAILING_LIST_MULTI=-1,SPF_HELO_PASS=-0.001, T_DMARC_POLICY_NONE=0.01 autolearn=ham autolearn_force=no version=3.4.4 X-Spam-BL-Results: Received: from mail.archlinux.org (mail.archlinux.org [IPv6:2a01:4f9:c010:3052::1]) by apollo.archlinux.org (Postfix) with ESMTPS for ; Mon, 7 Dec 2020 22:31:40 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=archlinux.org; s=luna2; t=1607379746; bh=QQUZtZV7kREnkVTviWM2NY/F581FNGWI3KF6Oy/XQQ4=; h=From:To:Date:In-Reply-To:References:Subject:List-Id: List-Unsubscribe:List-Archive:List-Post:List-Help:List-Subscribe: Reply-To; b=UmTOGJgyH6cnP0YgAruj5L5BaUrAjp/cCjZ2IiqcqoYW3bKtvaKHe2SiqkbAyGbnA s1TRiKYVESwIuOjB3V5PBFeBu1MC1xhVF5aaIy3ZwQZ/ugt46chEribkTZxlHnuhIn kqa5mtzEJ7G6md5sEMCHwhMBkQMdupGczDqMASPLhfwxh/vTIpNe0tKrfAt0IegmwY 12FzF2ZPD52I9U5kahMNKyIO520lDcWRLfQHjXLcL4uKPB8MzvKSQCQr4jL7gadaL8 qkVqGo9hIYza3+rDqsCLdgRJR8aYCeBlpKt2RodUVH8prnc8RU+v2bcWZqTRLEbkah 5wpHnpHoYZFi0JmGFX9nkZ1Cnq/LliRyCIXucihnmzfx/MUxLhsuTiHQBC9Kc0JvSE iu596Cgii3ZCzloZ5mdnf3+NnCdFeBVhghWt4Y6mZCLU3Jmci79QEUFd9mtAn2ZJFC weeumLdjXeSKy1RDTN6rwlJ9M8WUF7QHhwkGwM02W/mJDljVTIfA61dAxxZYJKKanl DZoPIkU/cPwoYipeEFhz15IuA4wzYbCfiXDSPGigyPuuz+FRjneMBBC0S2ugtY1DSX SG4yxMsLuHCsJo7oQsD8+xgF2A44a4PGg3NBuUOMZuSfq+XY7zPIHkLSYQYkujeRy3 1o8Kniy+PuGbXBL+4aYRpcOc= DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=archlinux.org; s=dkim-rsa; t=1607380290; h=from:from:sender:sender:reply-to:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=YO29Dv2097/o3vuXwel9f+GLPwE1YkEYBZs3fS9Nty8=; b=qLZzsmoNbxyy+2/k0a6S/gx9DuUwuOvfUMs4zdrYlXz2zfHla34c6P2zRF8TriW26zbskW anKctb5H+6oP1oBt7ue/dOcknzJwzI/gR7BU79Nbb2q20av/RQBUmE3UacWtcM7n53pA9p Vt95DcBmNHjsS5MBUQ2rFUh+Fc+pq1mBTcVgUWrbgo3nEHRs7bfpfUktbm2ub/7ZaEQDfY RT1+4zk0uq7R3moX5IAEUKWEX0+B55h2lVKbg4Pr7yLWk82lSXbRnpzVZNtepyL4y7S3+Y 9Q6oxaVnJrdUy7G8Ok5HOR0ZoFWpdGk7bx3X0W2XsBwEuOftPY3RmFJrgHdW/LXn1obYCa rdB2CRRIeDyUgPx2lh9NyDFgruQp4Rzhd8D86MgVmEaQzjajqMgrMlObD6k62Hul8scGkO UmbIz6jMndGtaWJujxmMcD20hX1cAyCB2LRKgmfCoSwyjp2rqoCNHyvImBqEs0Prfd/Rga 9jhlaLGR9ig92rag/RPhc30oO9X3LJqRw5yUrDr5LNv9XnAUerlp5nF4Vw8u1rY9JLw9L/ Dnt8s+NFk1zH0sCo7XCysYBpZajatpd30wMKnkmKQ1TbT5X3KTQlbgjia2Dl4QROXbuSX7 CxnGKJ1Trdqr9Cv5wEbmC4TcNmJ1optMITbgh26p/Vq1wiJzoPs0Y= DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=archlinux.org; s=dkim-ed25519; t=1607380290; h=from:from:sender:sender:reply-to:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=YO29Dv2097/o3vuXwel9f+GLPwE1YkEYBZs3fS9Nty8=; b=abOD13odXvTDMNZcZcNkc6GThk9aOn8zt9z2YWe/ef/IKmG99RjlO4S+WgEf7fYmNLRUpm E+Uu8jvDVb7vXBCA== From: morganamilo DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=archlinux.org; s=dkim-rsa; t=1607379739; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=YO29Dv2097/o3vuXwel9f+GLPwE1YkEYBZs3fS9Nty8=; b=hGdEQmENCbE0Fg91yRXQWU6hr5H9ArHQaIYqXytIKCIS+FELVUDy7GW8THfCTW1JUayQHU WGtSbV+1TApbQiduQ6sKdM1Jvy9cH0wUddg+/w9QUweEi1+IdalIg71tzksIXDbT1I8Hz8 RY1qPGT6SXcLRNGDI+Lt1pdOIM78F6pHLGqPgUW/Le4LHUSByWiYgi6Hjv/SelACvFhKX+ zb7EkDg7/GT7/38zOnYy9SaZYjUrMb7rMF/djUAEQz4/JFlUPFh6UzDD5mZsQL00v30NlI pBJQcfAC6Lxz7bN+Gro7yLWjN2lGCGeYGu7S5qwtJCZMAzc/HshkcGashzme8XbDdQf6RW lYkBH4Zz0PyZkDpz9TL1f119NgExCWmssebjdWZoHCXooGgP4whn6JXG8YU8LPc5Tlp3RR TMaVAzwuiJNMJqu6mr9uZIT+Oqy0wwQBQsjKtgIBLc12hj9DHfh4z80yteqxr7/6qF7yEB 2ae6u1t82q9Zx11/w0dqCmWhw2f6AirbSMrgDrOcVFK/pM73wSmgc+oK1NwBfIG472yreU o9eRPcSPyAvOWZrEg9mVRau+qyorluMKEfEs2np1SIrDEAyYdJix9jd/nKgiPcpyjeesFr eIWdIgYi9HQ06ni3hbNS84N6SPPoHsZCGuEgDqkom3pfUicKTm0FM= DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=archlinux.org; s=dkim-ed25519; t=1607379739; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=YO29Dv2097/o3vuXwel9f+GLPwE1YkEYBZs3fS9Nty8=; b=d+UlH44w0F876N5S19Bpy1t7CJ0YH64gJeKvdOeHrLfjxQ8s+dTpNxw+upxU1oWBt0prlc MP4KyXk6JLGLJiAA== To: pacman-dev@archlinux.org Date: Mon, 7 Dec 2020 22:19:55 +0000 Message-Id: <20201207221956.667322-23-morganamilo@archlinux.org> X-Mailer: git-send-email 2.29.2 In-Reply-To: <20201207221956.667322-1-morganamilo@archlinux.org> References: <20201207221956.667322-1-morganamilo@archlinux.org> MIME-Version: 1.0 Subject: [pacman-dev] [PATCH 22/23] doc: change group names to libalpm_* X-BeenThere: pacman-dev@archlinux.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: Discussion list for pacman development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: Discussion list for pacman development Errors-To: pacman-dev-bounces@archlinux.org Sender: "pacman-dev" Authentication-Results: mail.archlinux.org; auth=pass smtp.auth=luna smtp.mailfrom=pacman-dev-bounces@archlinux.org Also change the group's title to point to the group's man page. This makes generated man pages be named libalpm_* which is more consistent with what library man pages are usually called. --- doc/meson.build | 1 - lib/libalpm/alpm.h | 80 +++++++++++++++++++++++++---------------- lib/libalpm/alpm_list.h | 22 ++---------- 3 files changed, 53 insertions(+), 50 deletions(-) diff --git a/doc/meson.build b/doc/meson.build index e24172fd..570dc765 100644 --- a/doc/meson.build +++ b/doc/meson.build @@ -9,7 +9,6 @@ manpages = [ { 'name': 'PKGBUILD.5', 'extra_depends' : [ 'PKGBUILD-example.txt' ] }, { 'name': 'makepkg.conf.5' }, { 'name': 'pacman.conf.5' }, - { 'name': 'libalpm.3' }, { 'name': 'BUILDINFO.5' }, { 'name': 'pacman-conf.8' }, ] diff --git a/lib/libalpm/alpm.h b/lib/libalpm/alpm.h index b2772f19..dd28b191 100644 --- a/lib/libalpm/alpm.h +++ b/lib/libalpm/alpm.h @@ -21,13 +21,6 @@ * along with this program. If not, see . */ -/** - * @file alpm.h - * @author Pacman Development Team - * @date 7 Dec 2020 - * @brief Arch Linux Package Manager Library - */ - /** @mainpage alpm * * libalpm is a package management library, primaraly used by pacman. @@ -50,14 +43,41 @@ extern "C" { #include -/** @addtogroup alpm The libalpm Public API +/** @addtogroup libalpm The libalpm Public API + * + * + * libalpm is a package management library, primaraly used by pacman. + * + * For ease of access, the libalpm manual has been split up into several sections. * - * @section see_also See Also - * \b alpm_list(3), + * @section bugs Bugs + * Bugs? You must be kidding; there are no bugs in this software. But if we happen to be wrong, + * submit a bug report with as much detail as possible at the Arch Linux Bug Tracker in the + * Pacman section. + * + * @section see_also See also + * \b libalpm-list(3), * \b alpm-hooks(5), * \b makepkg(8), - * \b pacman(8), - * \b pacman.conf(5) + * + * @section maintainers Maintainers + * Current maintainers: + * + * - Allan McRae + * - Andrew Gregory + * - Dave Reisner + * - Eli Schwartz + * + * Past major contributors: + * + * - Judd Vinet + * - Aurelien Foret + * - Aaron Griffin + * - Dan McGee + * - Xavier Chantry + * - Nagy Gabor + * + * For additional contributors, use git shortlog -s on the pacman.git repository. * @{ */ @@ -68,7 +88,7 @@ extern "C" { /** The libalpm context handle. * * This struct represents an instance of libalpm. - * @ingroup alpm_handle + * @ingroup libalpm-handle */ typedef struct __alpm_handle_t alpm_handle_t; @@ -88,7 +108,7 @@ typedef struct __alpm_handle_t alpm_handle_t; * the user. They will be freed when the database is unregistered. * * Databases are automatically unregistered when the \link alpm_handle_t \endlink is released. - * @ingroup alpm_databases + * @ingroup libalpm-databases */ typedef struct __alpm_db_t alpm_db_t; @@ -101,21 +121,21 @@ typedef struct __alpm_db_t alpm_db_t; * * Packages can then be queried for metadata or added to a \link alpm_trans_t transaction \endlink * to be added or removed from the system. - * @ingroup alpm_packages + * @ingroup libalpm-packages */ typedef struct __alpm_pkg_t alpm_pkg_t; /** Transaction structure used internally by libalpm - * @ingroup alpm_trans + * @ingroup libalpm-trans * */ typedef struct __alpm_trans_t alpm_trans_t; /** The time type used by libalpm. Represents a unix time stamp - * @ingroup alpm_misc */ + * @ingroup libalpm-misc */ typedef int64_t alpm_time_t; -/** @addtogroup alpm_files Files +/** @addtogroup libalpm-files libalpm-files(3) * @brief Functions for package files * @{ */ @@ -160,7 +180,7 @@ alpm_file_t *alpm_filelist_contains(alpm_filelist_t *filelist, const char *path) /** @} */ -/** @addtogroup alpm_groups Groups +/** @addtogroup libalpm-groups libalpm-groups(3) * @brief Functions for package groups * @{ */ @@ -186,7 +206,7 @@ alpm_list_t *alpm_find_group_pkgs(alpm_list_t *dbs, const char *name); /** @} */ -/** @addtogroup alpm_errors Error Codes +/** @addtogroup libalpm-errors libalpm-errors(3) * Error codes returned by libalpm. * @{ */ @@ -330,7 +350,7 @@ const char *alpm_strerror(alpm_errno_t err); /** @} */ -/** \addtogroup alpm_handle Handle +/** \addtogroup libalpm-handle libalpm-handle(3) * @brief Functions to initialize and release libalpm * @{ */ @@ -360,7 +380,7 @@ int alpm_release(alpm_handle_t *handle); /** @} */ -/** @addtogroup alpm_sig Signature checking +/** @addtogroup libalpm-sig libalpm-sig(3) * @brief Functions to check signatures * @{ */ @@ -526,7 +546,7 @@ int alpm_extract_keyid(alpm_handle_t *handle, const char *identifier, /** @} */ -/** @addtogroup alpm_depends Dependency +/** @addtogroup libalpm-depends libalpm-depends(3) * @brief Functions dealing with libalpm's dependency and conflict * information. * @{ @@ -703,7 +723,7 @@ void alpm_conflict_free(alpm_conflict_t *conflict); /** @} */ -/** \addtogroup alpm_cb Callbacks +/** \addtogroup libalpm-cb libalpm-cb(3) * @brief Functions and structures for libalpm's callbacks * @{ */ @@ -1208,7 +1228,7 @@ typedef int (*alpm_cb_fetch)(const char *url, const char *localpath, /** @} */ -/** @addtogroup alpm_databases Database +/** @addtogroup libalpm-databases libalpm-database(3) * @brief Functions to query and manipulate the database of libalpm. * @{ */ @@ -1426,7 +1446,7 @@ int alpm_db_get_usage(alpm_db_t *db, int *usage); /** @} */ -/** \addtogroup alpm_log Logging Functions +/** \addtogroup libalpm-log alpm-log(3) * @brief Functions to log using libalpm * @{ */ @@ -1468,7 +1488,7 @@ int alpm_logaction(alpm_handle_t *handle, const char *prefix, /** @} */ -/** @addtogroup alpm_options Options +/** @addtogroup libalpm-options libalpm-options(3) * Libalpm option getters and setters * @{ */ @@ -2184,7 +2204,7 @@ int alpm_option_set_parallel_downloads(alpm_handle_t *handle, unsigned int num_s /** @} */ -/** @addtogroup alpm_packages Package Functions +/** @addtogroup libalpm-packages libalpm-packages(3) * Functions to manipulate libalpm packages * @{ */ @@ -2619,7 +2639,7 @@ int alpm_pkg_mtree_close(const alpm_pkg_t *pkg, struct archive *archive); /* End of alpm_packages */ /** @} */ -/** @addtogroup alpm_trans Transaction +/** @addtogroup libalpm-trans libalpm-trans(3) * @brief Functions to manipulate libalpm transactions * * Transactions are the way to add/remove packages to/from the system. @@ -2763,7 +2783,7 @@ int alpm_remove_pkg(alpm_handle_t *handle, alpm_pkg_t *pkg); /** @} */ -/** \addtogroup alpm_misc Miscellaneous Functions +/** \addtogroup libalpm-misc libalpm-misc(3) * @brief Various libalpm functions * @{ */ diff --git a/lib/libalpm/alpm_list.h b/lib/libalpm/alpm_list.h index 01fa092c..620cfbfd 100644 --- a/lib/libalpm/alpm_list.h +++ b/lib/libalpm/alpm_list.h @@ -19,23 +19,6 @@ */ -/** - * @file alpm_list.h - * @author Pacman Development Team - * @date 7 Dec 2020 - * @brief A doubly linked list for use with libalpm - * - * @section see_also See Also - * \b alpm(3), - * \b alpm-hooks(5), - * \b makepkg(8), - * \b pacman(8), - * \b pacman.conf(5) - * @{ - */ - - */ - #ifndef ALPM_LIST_H #define ALPM_LIST_H @@ -50,7 +33,8 @@ extern "C" { #endif /** - * @addtogroup alpm_list List Functions + * @ingroup libalpm + * @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 @@ -60,7 +44,7 @@ extern "C" { * It is exposed so front ends can use it to prevent the need to reimplement * lists of their own; however, it is not required that the front end uses * it. - * @{ + * @{ */ /** A doubly linked list */