From patchwork Wed Aug 3 17:00:21 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ben Westover X-Patchwork-Id: 2078 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 17:00:27 +0000 (UTC) Received: from mail.archlinux.org by mail.archlinux.org with LMTP id ACzrJKqp6mIl4wUAK+/4rw (envelope-from ) for ; Wed, 03 Aug 2022 17:00:26 +0000 Received: from lists.archlinux.org (lists.archlinux.org [95.217.236.249]) (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 3D0FD12CEC6F; Wed, 3 Aug 2022 17:00:25 +0000 (UTC) Received: from lists.archlinux.org (localhost [IPv6:::1]) by lists.archlinux.org (Postfix) with ESMTP id 180D012A47CE; Wed, 3 Aug 2022 17:00:25 +0000 (UTC) X-Original-To: pacman-dev@lists.archlinux.org Delivered-To: pacman-dev@lists.archlinux.org Received: from mail-qv1-xf2f.google.com (mail-qv1-xf2f.google.com [IPv6:2607:f8b0:4864:20::f2f]) by lists.archlinux.org (Postfix) with ESMTPS id A2E5A12A47C7 for ; Wed, 3 Aug 2022 17:00:23 +0000 (UTC) Received: by mail-qv1-xf2f.google.com with SMTP id mk9so10548222qvb.11 for ; Wed, 03 Aug 2022 10:00:23 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:in-reply-to:references:to:from :content-language:subject:user-agent:mime-version:date:message-id :from:to:cc; bh=HOOXJZVUu4bABY+ybp1H8P/sM+I7QwwXPV3+uob3u6U=; b=i5lSDu2VgUWG6RF/kQLexKLvN/GwRKuaWMRjhlC1evNJ8lysQX61e6afo8bpTS2fPo vwZ/0dkzDMPnneOuWrausJOqo5IYYhIdzYFSPKK4B5hqnjuHGVekxjNVPnWetIW2AtyB 9fM70jUeAJ38sQBTjUpFHIJVbcVbcwo5etThCLnnOZ5pBOqSzPUzCTkgc7MH1MN+KROM Px2uYmTtNu6ZEXrXHsAc+HEOIjilUB+Ydpq2S8Ro9K1YRGS+jrtbqIeLTQ96DhO1bbd8 9VFC5/WjRF4m+piO2VUuI6uzS5cR1ga1p3XeEH2ciqel2jHL24hrWxQLEBhBDOugSIdo AptQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:in-reply-to:references:to:from :content-language:subject:user-agent:mime-version:date:message-id :x-gm-message-state:from:to:cc; bh=HOOXJZVUu4bABY+ybp1H8P/sM+I7QwwXPV3+uob3u6U=; b=Pb+pNVKaHVPCdrCPdhf4PGnIwwQXRAp9yZ0tar6CY06OlSxt5Eb04jZpGZIto7HlNS 73BIJt4ibPKSpyJx5kNVOB6RAN47gdD4weLr4HsoUD+mMepEcYtFAHIqjLuBL1kDCaCc axH1b/Qt+9dvCRtCJd0TEmJIa5iskYFjzOBc3WhvAeaMi6DFHp6UalvjyW+pdVBQwbQa vdUPd+If22Yb5ToL9pjD94PlohKpQE4LKwA8UXNt61YTxtkpyWAMx1kUn0b/2bmX1vja qztF43rw/84lvnWA0v2cY65t1qR6hby1k2XIL3AB1vpWriWNc6u88NmBXzvGOX+BH3H9 /sgw== X-Gm-Message-State: ACgBeo3htMbMJkKi364xFXOavEAmQTgAyUhxTKxrl0agFEczGk+MQ8Su NyUGsExAZWJmIqp6SAnTdqDvY9d98XPGTZi4 X-Google-Smtp-Source: AA6agR58UAOnzudCxVT0bIUFKezTykbgjGWgwQey4+OJ/dM6Qx1iR/a9MqTjFfap9gBf1akCfVVAVQ== X-Received: by 2002:a05:6214:2625:b0:474:742b:a59e with SMTP id gv5-20020a056214262500b00474742ba59emr22514542qvb.126.1659546022347; Wed, 03 Aug 2022 10:00:22 -0700 (PDT) Received: from [192.168.1.115] (static-95-221.sssnet.com. [24.140.95.221]) by smtp.gmail.com with ESMTPSA id y10-20020a37f60a000000b006a758ce2ae1sm12368369qkj.104.2022.08.03.10.00.21 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Wed, 03 Aug 2022 10:00:21 -0700 (PDT) Message-ID: Date: Wed, 3 Aug 2022 13:00:21 -0400 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101 Thunderbird/91.12.0 Subject: [PATCHv2] doc: Create documentation for pacman-db-upgrade and testpkg Content-Language: en-US From: Ben Westover To: Allan McRae , pacman-dev@lists.archlinux.org References: <2ef7d8a9-b4b9-2500-243d-abcfe9ad87ad@gmail.com> In-Reply-To: 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)[]; MAILLIST(-0.20)[mailman]; RCVD_IN_DNSWL_MED(-0.20)[95.217.236.249:from]; R_SPF_ALLOW(-0.20)[+ip4:95.217.236.249:c]; R_DKIM_ALLOW(-0.20)[gmail.com:s=20210112]; MIME_GOOD(-0.10)[text/plain]; HAS_LIST_UNSUB(-0.01)[]; RCVD_COUNT_FIVE(0.00)[5]; FROM_HAS_DN(0.00)[]; FROM_NEQ_ENVFROM(0.00)[kwestoverkw@gmail.com,pacman-dev-bounces@lists.archlinux.org]; RCVD_VIA_SMTP_AUTH(0.00)[]; PREVIOUSLY_DELIVERED(0.00)[pacman-dev@lists.archlinux.org]; ARC_NA(0.00)[]; RCVD_IN_DNSWL_NONE(0.00)[2607:f8b0:4864:20::f2f:received]; DWL_DNSWL_NONE(0.00)[gmail.com:dkim]; ASN(0.00)[asn:24940, ipnet:95.217.0.0/16, country:DE]; MID_RHS_MATCH_FROM(0.00)[]; DKIM_TRACE(0.00)[gmail.com:+]; FREEMAIL_FROM(0.00)[gmail.com]; TO_DN_SOME(0.00)[]; TAGGED_FROM(0.00)[]; RCPT_COUNT_TWO(0.00)[2]; MIME_TRACE(0.00)[0:+]; RECEIVED_SPAMHAUS_PBL(0.00)[24.140.95.221:received]; NEURAL_HAM(-0.00)[-1.000]; RCVD_TLS_LAST(0.00)[]; FORGED_SENDER_MAILLIST(0.00)[] X-Rspamd-Queue-Id: 3D0FD12CEC6F Authentication-Results: mail.archlinux.org; dkim=pass header.d=gmail.com header.s=20210112 header.b=i5lSDu2V; spf=pass (mail.archlinux.org: domain of pacman-dev-bounces@lists.archlinux.org designates 95.217.236.249 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 Signed-off-by: Ben Westover --- doc/meson.build | 2 ++ doc/pacman-db-upgrade.8.asciidoc | 36 ++++++++++++++++++++++++++++++++ doc/testpkg.8.asciidoc | 20 ++++++++++++++++++ 3 files changed, 58 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..34077093 --- /dev/null +++ b/doc/pacman-db-upgrade.8.asciidoc @@ -0,0 +1,36 @@ +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. + +Options +-------------- +*-h, \--help*:: +Show the built-in help message and exit. +*-V, \--version*:: +Show version information and exit. +*-d, \--dbpath* :: +Set an alternate database location. +*-r, \--root* :: +Set an alternate installation root. +*\--config* :: +Set an alternate configuration file. +*\--nocolor*:: +Remove color from output. + +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..cec94839 --- /dev/null +++ b/doc/testpkg.8.asciidoc @@ -0,0 +1,20 @@ +testpkg(8) +========== + +Name +---- +testpkg - test a pacman package for validity + +Synopsis +-------- +'testpkg' + +Description +----------- +'testpkg' is a script used to make sure that a pacman package is valid. + +See Also +-------- +linkman:pacman[8] + +include::footer.asciidoc[]