From patchwork Fri Jun 28 18:55:46 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jelle van der Waa X-Patchwork-Id: 1160 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 C10E710656564 for ; Fri, 28 Jun 2019 18:56:02 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on apollo X-Spam-Level: X-Spam-Status: No, score=-3.3 required=5.0 tests=DKIM_SIGNED=0.1, DKIM_VALID=-0.1,MAILING_LIST_MULTI=-1,RCVD_IN_DNSWL_MED=-2.3, SPF_HELO_NONE=0.001 autolearn=unavailable autolearn_force=no version=3.4.2 X-Spam-BL-Results: [127.0.9.2] Received: from orion.archlinux.org (orion.archlinux.org [IPv6:2a01:4f8:160:6087::1]) by apollo.archlinux.org (Postfix) with ESMTPS for ; Fri, 28 Jun 2019 18:56:02 +0000 (UTC) Received: from orion.archlinux.org (localhost [127.0.0.1]) by orion.archlinux.org (Postfix) with ESMTP id AE86813966C628; Fri, 28 Jun 2019 18:55:58 +0000 (UTC) Received: from luna.archlinux.org (luna.archlinux.org [5.9.250.164]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange ECDHE (P-384) server-signature RSA-PSS (4096 bits)) (No client certificate requested) by orion.archlinux.org (Postfix) with ESMTPS; Fri, 28 Jun 2019 18:55:58 +0000 (UTC) Received: from luna.archlinux.org (luna.archlinux.org [127.0.0.1]) by luna.archlinux.org (Postfix) with ESMTP id 9500B2C30C; Fri, 28 Jun 2019 18:55:58 +0000 (UTC) Authentication-Results: luna.archlinux.org; dkim=pass (2048-bit key) header.d=vdwaa-nl.20150623.gappssmtp.com header.i=@vdwaa-nl.20150623.gappssmtp.com header.b=VCf4wcQD Received: from luna.archlinux.org (luna.archlinux.org [127.0.0.1]) by luna.archlinux.org (Postfix) with ESMTP id C051F2C308 for ; Fri, 28 Jun 2019 18:55:53 +0000 (UTC) Received: from orion.archlinux.org (orion.archlinux.org [IPv6:2a01:4f8:160:6087::1]) by luna.archlinux.org (Postfix) with ESMTPS for ; Fri, 28 Jun 2019 18:55:53 +0000 (UTC) Received: from orion.archlinux.org (localhost [127.0.0.1]) by orion.archlinux.org (Postfix) with ESMTP id DB41C13966C623 for ; Fri, 28 Jun 2019 18:55:50 +0000 (UTC) Received: from mail-ed1-x535.google.com (mail-ed1-x535.google.com [IPv6:2a00:1450:4864:20::535]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange ECDHE (P-384) server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by orion.archlinux.org (Postfix) with ESMTPS for ; Fri, 28 Jun 2019 18:55:50 +0000 (UTC) Received: by mail-ed1-x535.google.com with SMTP id k8so11970889edr.11 for ; Fri, 28 Jun 2019 11:55:50 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=vdwaa-nl.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=pGLYun8/vCuIHllikMWei131nUiwpAObv7uK+8mfm9k=; b=VCf4wcQDbDrQ2WyhbVLQW2F7dbCFEAb1E1NeZB42Juq50VvZHGkWnq77ozNLBBeJBC hDND37eNwpVpWAsUV0kjdbfGlAqJTfI212eCKoY7C1PQIWwLqpc/xVI8kTcyCkPQtIIc egNNkUxHBsB4UP2nsLTwXFUTLdQdUAL8Lu4h1B8fVbzmQrO3yfFoGa1YNsDAYfs/g2d3 T2axCCKhFqxg7wOH5knW0d/XzfiUNpqYS5Df8nnMAGVjPN+SI4URoILsLmGSHSEXwdH3 tkK9h67w/FGjzLn5B/HpzLCEvXx9JX9u38acuJamkWaEd8fVfHl9cBuUtyXacPj8fdR3 gQ4A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=pGLYun8/vCuIHllikMWei131nUiwpAObv7uK+8mfm9k=; b=Q5J0fVYUtDMeVvm9QCX8bnWZu2/vZ2CjN5/2NYKRmbHkz1YYx9nG2jAfKlVhWL4hoJ 8gCfYEr3U5fR88VV9r+PxMkRsugQzid1p3bmzir1vlPLTT0Vu9jprbfdX5bX56EgH6Um V1zo1aNQqNrVlsRJazJ+8r5WdTRrXZHAafajBg0kiAZr9sD9t2guolWyYFuob0LEQMFZ MVLmXyLJ4vB84Ddb6hcyQZt5Yjayx29r5Y5rx36wdz5SAW2rcXsQZGCutMy+EFo0cG5W as/jA3UN7nEGRGfal4BgSabhzoucJYeONK/RhBYUDATryg3Z3Z4JbdbqPmq4LmVQ9oXw Y8NQ== X-Gm-Message-State: APjAAAWChyaKjfhLdAgWI2nWf4LDmlJlAgqDyx4NbfMx9LDq3iW7GSJi vUy7zoMeaChVYwlZiU99YrNrkoMo8l9L8w== X-Google-Smtp-Source: APXvYqzIZv1mGMRFsHl/VGzLUFSZ4jckp7+NRCeoJS3Tm/eOdmIRsCh84Wu+mmO20tCEbDUS7xlm6g== X-Received: by 2002:a17:906:590d:: with SMTP id h13mr10229533ejq.210.1561748149963; Fri, 28 Jun 2019 11:55:49 -0700 (PDT) Received: from helium.space.revspace.nl ([2a01:4f8:1c0c:6c86:997e:5a09:8f9:e9b8]) by smtp.gmail.com with ESMTPSA id v32sm936098edm.92.2019.06.28.11.55.48 (version=TLS1_3 cipher=AEAD-AES256-GCM-SHA384 bits=256/256); Fri, 28 Jun 2019 11:55:48 -0700 (PDT) From: Jelle van der Waa To: pacman-dev@archlinux.org Date: Fri, 28 Jun 2019 20:55:46 +0200 Message-Id: <20190628185546.10462-1-jelle@vdwaa.nl> X-Mailer: git-send-email 2.22.0 In-Reply-To: <20190621213913.21263-1-jelle@vdwaa.nl> References: <20190621213913.21263-1-jelle@vdwaa.nl> MIME-Version: 1.0 Subject: [pacman-dev] [PATCH v2] doc: Add a man page describing PKGINFO X-BeenThere: pacman-dev@archlinux.org X-Mailman-Version: 2.1.29 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 Cc: Jelle van der Waa Errors-To: pacman-dev-bounces@archlinux.org Sender: "pacman-dev" From: Jelle van der Waa Describe the PKGINFO format which resides in a package produced makepkg. --- doc/Makefile.am | 4 +- doc/PKGINFO.5.asciidoc | 87 ++++++++++++++++++++++++++++++++++++++++++ doc/meson.build | 1 + 3 files changed, 91 insertions(+), 1 deletion(-) create mode 100644 doc/PKGINFO.5.asciidoc diff --git a/doc/Makefile.am b/doc/Makefile.am index 5c575832..634388e8 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -16,7 +16,8 @@ MANPAGES = \ pacman.conf.5 \ libalpm.3 \ BUILDINFO.5 \ - pacman-conf.8 + pacman-conf.8 \ + PKGINFO.5 DOXYGEN_MANS = $(wildcard man3/*.3) @@ -47,6 +48,7 @@ EXTRA_DIST = \ makepkg.conf.5.asciidoc \ pacman.conf.5.asciidoc \ BUILDINFO.5.asciidoc \ + PKGINFO.5.asciidoc \ libalpm.3.asciidoc \ footer.asciidoc \ index.asciidoc \ diff --git a/doc/PKGINFO.5.asciidoc b/doc/PKGINFO.5.asciidoc new file mode 100644 index 00000000..101ba34c --- /dev/null +++ b/doc/PKGINFO.5.asciidoc @@ -0,0 +1,87 @@ +///// +vim:set ts=4 sw=4 syntax=asciidoc noet spell spelllang=en_us: +///// +PKGINFO(5) +========== + +Name +---- +PKGINFO - package information file + + +Synopsis +-------- +This manual page describes the format of a PKGINFO file found in the root of +a package created by makepkg. The file contains a description of the package's +information. The information is formatted in key-value pairs separated by +a '=', one value per line. Arrays are represented multiple keys with the same +value. + + +Description +----------- + +*pkgname*:: + The name of the package. + +*pkgbase*:: + The base name of a package, usually the same as the pkgname except for + split packages. + +*pkgver*:: + The version of the package including pkgrel and epoch. + +*pkgdesc*:: + A description of the software contained in the package. + +*url*:: + The upstream url of the package. + +*builddate*:: + The build date of the package in epoch. + +*packager*:: + The packager of the package formatted "Name ". + +*size*:: + The size of the package in bytes. + +*arch*:: + The architecture of the package. + +*license*:: + The license of the package. + +*replaces (array)*:: + An array of packages that this package should replace. + +*group (array)*:: + An array of names that represent groups of packages. + +*conflict (array)*:: + An array of packages that will conflict with this package. + +*provides (array)*:: + An array of "virtual provisions" this package provides. + +*backup (array)*:: + An array of file names, which should be backed up if the package is removed + or upgraded. + +*depend (array)*:: + The dependencies of the package. + +*optdepend (array)*:: + The optional dependencies of the package. + +*makedepend (array)*:: + The make dependencies of the package. + +*checkdepend (array)*:: + The check dependencies of the package. + +See Also +-------- +linkman:makepkg[8], linkman:pkgbuild[5] + +include::footer.asciidoc[] diff --git a/doc/meson.build b/doc/meson.build index a5bcd5b3..2f966616 100644 --- a/doc/meson.build +++ b/doc/meson.build @@ -12,6 +12,7 @@ manpages = [ { 'name': 'libalpm.3' }, { 'name': 'BUILDINFO.5' }, { 'name': 'pacman-conf.8' }, + { 'name': 'PKGINFO.5' }, ] sitepages = [