From patchwork Wed Aug 3 01:58:56 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ben Westover X-Patchwork-Id: 2077 Return-Path: Delivered-To: patchwork@archlinux.org Received: from mail.archlinux.org [2a01:4f9:c010:3052::1] by patchwork.archlinux.org with IMAP (fetchmail-6.4.31) for (single-drop); Wed, 03 Aug 2022 01:59:04 +0000 (UTC) Received: from mail.archlinux.org by mail.archlinux.org with LMTP id 2JjBJ2fW6WJUhQUAK+/4rw (envelope-from ) for ; Wed, 03 Aug 2022 01:59:03 +0000 Received: from lists.archlinux.org (lists.archlinux.org [IPv6:2a01:4f9:c010:9eb4::1]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by mail.archlinux.org (Postfix) with ESMTPS id E85A512C941E; Wed, 3 Aug 2022 01:59:01 +0000 (UTC) Received: from lists.archlinux.org (localhost [IPv6:::1]) by lists.archlinux.org (Postfix) with ESMTP id B29BC12A0761; Wed, 3 Aug 2022 01:59:01 +0000 (UTC) X-Original-To: pacman-dev@lists.archlinux.org Delivered-To: pacman-dev@lists.archlinux.org Received: from mail-qt1-x832.google.com (mail-qt1-x832.google.com [IPv6:2607:f8b0:4864:20::832]) by lists.archlinux.org (Postfix) with ESMTPS id BB10612A0751 for ; Wed, 3 Aug 2022 01:58:59 +0000 (UTC) Received: by mail-qt1-x832.google.com with SMTP id ey23so2033675qtb.11 for ; Tue, 02 Aug 2022 18:58:59 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:subject:from:to:content-language :user-agent:mime-version:date:message-id:from:to:cc; bh=Xx8TCzk3xsIa9T0ojMZme9vq05us5XJIUAljXepzhIU=; b=mZc4F76CUCrZiTy32G39WVAF5EBHm+V7QYaVE+qTseevpf6jGAjjOf9F7Y60Ah/ecN lu8rEeChTb1SkB6R3NlR7DvwQW35Gk3E+5rB2j5DqFM92/pfNoNjqvyHh24dkIS2Fe7T wI50cyswfEp9s4ux0D1MDett5LddVkvbVrv8OCIVFdC5v4BTeDBu3IYgupO4BD3qO+dZ siqcoC1Qb8zronV46HHQB2K657dDuMk2VC64Bb9pZ11iUAZxbQN4/UtLItMWvTyDRH9B YFu3BGrJH6L8ybOVd6/DM1rbg79cI+8Wh4bwBe5v+TksSnIgRpLBzBLN6b5rgz0YX/Vw JSIA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:subject:from:to:content-language :user-agent:mime-version:date:message-id:x-gm-message-state:from:to :cc; bh=Xx8TCzk3xsIa9T0ojMZme9vq05us5XJIUAljXepzhIU=; b=FQmIbdnig95kDsM1kmAPmKHgkrlAgZ9YG/4cWU8mYNtWEao1j/d8DwhAhrkL279RPg TC8JSZNTAysnIBzV9pA5vQDBs+vq6EjxiI7hlby6xzlxt5+3IJA7/QhLG4ef/S9uCcWX P+ThrDVucoE+yWeDL5c862fZ6vQBZRYxg3BADa/8qZCrRoPcD3d2/PO6vWKKxWdqQF11 /P/RErSv6kEeppQhKizkh3DvmCTqt3BP/aFmsGvLGVou71OQTeXu+MBXMpmu7MI8xsiP eV7wS99wyM1VFvLBMEDE22b/FGF1xYk3MUDDaLcqrPeQjJaNhYhJdkA8ze0iWoGtK8BL ZoNQ== X-Gm-Message-State: AJIora/+2ExaJy+AZ+FBD40qutUDKyGK3nXZg4KMP3gI/1Dnh5zx56tp k/p4X5jGXLhhnG9rfLJ2O9CoTFnFME7lqg== X-Google-Smtp-Source: AGRyM1vGpkAJvfmXHoYW0zPiR3wpnSujTLrblF/XW0GkjLkOdV+jeulju5qMsWVEiE63ZeCtjG8aPw== X-Received: by 2002:a05:622a:2c8:b0:31f:9df:3def with SMTP id a8-20020a05622a02c800b0031f09df3defmr20409081qtx.442.1659491937779; Tue, 02 Aug 2022 18:58:57 -0700 (PDT) Received: from [192.168.1.115] (static-95-221.sssnet.com. [24.140.95.221]) by smtp.gmail.com with ESMTPSA id ez15-20020a05622a4c8f00b0031bf5677d96sm9937181qtb.84.2022.08.02.18.58.56 for (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Tue, 02 Aug 2022 18:58:57 -0700 (PDT) Message-ID: <2ef7d8a9-b4b9-2500-243d-abcfe9ad87ad@gmail.com> Date: Tue, 2 Aug 2022 21:58:56 -0400 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101 Thunderbird/91.11.0 Content-Language: en-US To: pacman-dev@lists.archlinux.org From: Ben Westover Subject: [PATCH] doc: Create documentation for pacman-db-upgrade and testpkg X-BeenThere: pacman-dev@lists.archlinux.org X-Mailman-Version: 2.1.39 Precedence: list List-Id: Discussion list for pacman development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: pacman-dev-bounces@lists.archlinux.org Sender: "pacman-dev" X-Spamd-Result: default: False [-1.91 / 15.00]; DMARC_POLICY_ALLOW(-0.50)[gmail.com,none]; RCVD_DKIM_ARC_DNSWL_MED(-0.50)[]; R_DKIM_ALLOW(-0.20)[gmail.com:s=20210112]; MAILLIST(-0.20)[mailman]; R_SPF_ALLOW(-0.20)[+ip6:2a01:4f9:c010:9eb4::1:c]; RCVD_IN_DNSWL_MED(-0.20)[2a01:4f9:c010:9eb4::1:from]; MIME_GOOD(-0.10)[text/plain]; HAS_LIST_UNSUB(-0.01)[]; FROM_NEQ_ENVFROM(0.00)[kwestoverkw@gmail.com,pacman-dev-bounces@lists.archlinux.org]; RCVD_COUNT_FIVE(0.00)[5]; FROM_HAS_DN(0.00)[]; RCVD_VIA_SMTP_AUTH(0.00)[]; RCPT_COUNT_ONE(0.00)[1]; PREVIOUSLY_DELIVERED(0.00)[pacman-dev@lists.archlinux.org]; RCVD_IN_DNSWL_NONE(0.00)[2607:f8b0:4864:20::832:received]; ARC_NA(0.00)[]; MID_RHS_MATCH_FROM(0.00)[]; TAGGED_FROM(0.00)[]; DKIM_TRACE(0.00)[gmail.com:+]; TO_DN_NONE(0.00)[]; FREEMAIL_FROM(0.00)[gmail.com]; DWL_DNSWL_NONE(0.00)[gmail.com:dkim]; RECEIVED_SPAMHAUS_PBL(0.00)[24.140.95.221:received]; RCVD_TLS_LAST(0.00)[]; MIME_TRACE(0.00)[0:+]; NEURAL_HAM(-0.00)[-1.000]; ASN(0.00)[asn:24940, ipnet:2a01:4f9::/32, country:DE]; FORGED_SENDER_MAILLIST(0.00)[] X-Rspamd-Queue-Id: E85A512C941E Authentication-Results: mail.archlinux.org; dkim=pass header.d=gmail.com header.s=20210112 header.b=mZc4F76C; spf=pass (mail.archlinux.org: domain of pacman-dev-bounces@lists.archlinux.org designates 2a01:4f9:c010:9eb4::1 as permitted sender) smtp.mailfrom=pacman-dev-bounces@lists.archlinux.org; dmarc=pass (policy=none) header.from=gmail.com X-Rspamd-Server: mail.archlinux.org There are two "binaries" that are currently missing documentation, pacman-db-upgrade and testpkg. This patch adds that documentation. Signed-off-by: Ben Westover --- doc/meson.build | 2 ++ doc/pacman-db-upgrade.8.asciidoc | 39 ++++++++++++++++++++++++++++++++ doc/testpkg.8.asciidoc | 21 +++++++++++++++++ 3 files changed, 62 insertions(+) create mode 100644 doc/pacman-db-upgrade.8.asciidoc create mode 100644 doc/testpkg.8.asciidoc diff --git a/doc/meson.build b/doc/meson.build index 06df92c9..a18e7f3f 100644 --- a/doc/meson.build +++ b/doc/meson.build @@ -5,7 +5,9 @@ manpages = [ { 'name': 'makepkg-template.1' }, { 'name': 'repo-add.8' }, { 'name': 'vercmp.8' }, + { 'name': 'testpkg.8' }, { 'name': 'pacman-key.8' }, + { 'name': 'pacman-db-upgrade.8' }, { 'name': 'PKGBUILD.5', 'extra_depends' : [ 'PKGBUILD-example.txt' ] }, { 'name': 'makepkg.conf.5' }, { 'name': 'pacman.conf.5' }, diff --git a/doc/pacman-db-upgrade.8.asciidoc b/doc/pacman-db-upgrade.8.asciidoc new file mode 100644 index 00000000..d984179b --- /dev/null +++ b/doc/pacman-db-upgrade.8.asciidoc @@ -0,0 +1,39 @@ +pacman-db-upgrade(8) +==================== + +Name +---- +pacman-db-upgrade - upgrade the local pacman database to a newer format + +Synopsis +-------- +'pacman-db-upgrade' [options] + +Description +----------- +'pacman-db-upgrade' is a script that upgrades the local database used +by linkman:pacman[8] to a newer format. + +Common Options +-------------- +*-h, \--help*:: +Show the built-in help message and exit. +*-V, \--version*:: +Show version information and exit. +*\--nocolor*:: +Remove color from output. + +pacman-db-upgrade Options +------------------------- +*-d, \--dbpath* :: +Set an alternate database location. +*\--config* :: +Set an alternate configuration file. +*-r, \--root* :: +Sset an alternate installation root. + +See Also +-------- +linkman:pacman[8] + +include::footer.asciidoc[] diff --git a/doc/testpkg.8.asciidoc b/doc/testpkg.8.asciidoc new file mode 100644 index 00000000..6401a9be --- /dev/null +++ b/doc/testpkg.8.asciidoc @@ -0,0 +1,21 @@ +testpkg(8) +========== + +Name +---- +testpkg - test a pacman package for validity + +Synopsis +-------- +'testpkg' + +Description +----------- +'testpkg' is a script used to make sure packages produced by +linkman:makepkg[8] are valid. + +See Also +-------- +linkman:makepkg[8] + +include::footer.asciidoc[]