Add BUILDINFO man page

Add a new man page which describes the structure of a BUILDINFO file
included in a package produced by makepkg.

Signed-off-by: Jelle van der Waa <jelle@vdwaa.nl>
Signed-off-by: Allan McRae <allan@archlinux.org>
This commit is contained in:
Jelle van der Waa 2018-01-13 16:43:12 +01:00 committed by Allan McRae
parent 9058d7fe9a
commit a7dbe4635b
2 changed files with 70 additions and 1 deletions

67
doc/BUILDINFO.5.txt Normal file
View file

@ -0,0 +1,67 @@
/////
vim:set ts=4 sw=4 syntax=asciidoc noet spell spelllang=en_us:
/////
BUILDINFO(5)
============
Name
----
BUILDINFO - Makepkg package build information file
Synopsis
--------
This manual page describes the format of a BUILDINFO file found in the root of
a package created by makepkg. The file contains a description of the package's
build environment. 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
-----------
This is a description of the contents of version '1' of the
BUILDINFO file format.
*format*::
Denotes the file format version, represented by a plain positive integer.
*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.
*pkgbuild_sha256sum*::
The sha256sum in hex format of the PKGBUILD used to build the package.
*packager*::
The details of the packager that built the package.
*builddate*::
The build date of the package in epoch.
*builddir*::
The directory where the package was built.
*buildenv (array)*::
The build environment specified in makepkg.conf.
*options (array)*::
The options set specified when building the package.
*installed (array)*::
The installed packages at build time including the version information of
the package. Formatted as "$pkgname-$pkgver-$pkgrel".
See Also
--------
linkman:makepkg[8], linkman:pacman[8], linkman:makepkg.conf[5]
include::footer.txt[]

View file

@ -15,7 +15,8 @@ ASCIIDOC_MANS = \
PKGBUILD.5 \ PKGBUILD.5 \
makepkg.conf.5 \ makepkg.conf.5 \
pacman.conf.5 \ pacman.conf.5 \
libalpm.3 libalpm.3 \
BUILDINFO.5
DOXYGEN_MANS = $(wildcard man3/*.3) DOXYGEN_MANS = $(wildcard man3/*.3)
@ -58,6 +59,7 @@ EXTRA_DIST = \
PKGBUILD-example.txt \ PKGBUILD-example.txt \
makepkg.conf.5.txt \ makepkg.conf.5.txt \
pacman.conf.5.txt \ pacman.conf.5.txt \
BUILDINFO.5.txt \
libalpm.3.txt \ libalpm.3.txt \
footer.txt \ footer.txt \
index.txt \ index.txt \