[pacman-dev] [PATCH v3] Add BUILDINFO man page

[Jelle van der Waa]

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 at vdwaa.nl>
---
 doc/BUILDINFO.5.txt | 68 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 doc/Makefile.am     |  4 +++-
 2 files changed, 71 insertions(+), 1 deletion(-)
 create mode 100644 doc/BUILDINFO.5.txt

diff --git a/doc/BUILDINFO.5.txt b/doc/BUILDINFO.5.txt
new file mode 100644
index 00000000..32c65c83
--- /dev/null
+++ b/doc/BUILDINFO.5.txt
@@ -0,0 +1,68 @@
+/////
+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 usually found in 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 when
+	it's a split package.
+
+*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 packager which has built the package.
+
+*builddate*::
+	The build date of the package in epoch.
+
+*builddir*::
+	The build directory where the package has been build.
+
+*buildenv (array)*::
+	The set BUILDENV from makepkg.conf.
+
+*options (array)*::
+	A combination of the OPTIONS set in makekg.conf merged with the options set
+	in the used PKGBUILD.
+
+*installed (array)*::
+	The installed packages at build time including the version of the package.
+	Formatted as "$pkgname-$pkgver-$pkgrel".
+
+See Also
+--------
+linkman:makepkg[8], linkman:pacman[8], linkman:makepkg.conf[5]
+
+include::footer.txt[]
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 44e32996..bbf2af66 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -15,7 +15,8 @@ ASCIIDOC_MANS = \
 	PKGBUILD.5 \
 	makepkg.conf.5 \
 	pacman.conf.5 \
-	libalpm.3
+	libalpm.3 \
+	BUILDINFO.5
 
 DOXYGEN_MANS = $(wildcard man3/*.3)
 
@@ -58,6 +59,7 @@ EXTRA_DIST = \
 	PKGBUILD-example.txt \
 	makepkg.conf.5.txt \
 	pacman.conf.5.txt \
+	BUILDINFO.5.txt \
 	libalpm.3.txt \
 	footer.txt \
 	index.txt \
-- 
2.15.1