diff mbox

[pacman-dev,v4] Add BUILDINFO man page

Message ID 20180113154312.3963-1-jelle@vdwaa.nl
State Accepted, archived
Headers show

Commit Message

Jelle van der Waa Jan. 13, 2018, 3:43 p.m. UTC 
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>
---
 doc/BUILDINFO.5.txt | 67 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 doc/Makefile.am     |  4 +++-
 2 files changed, 70 insertions(+), 1 deletion(-)
 create mode 100644 doc/BUILDINFO.5.txt

Comments

Allan McRae Jan. 19, 2018, 2:10 a.m. UTC | #1 
On 14/01/18 01:43, Jelle van der Waa wrote:
> Add a new man page which describes the structure of a BUILDINFO file
> included in a package produced by makepkg.
> 

Looks good to me. On my patchqueue.

A
diff mbox

Patch

diff --git a/doc/BUILDINFO.5.txt b/doc/BUILDINFO.5.txt
new file mode 100644
index 00000000..b7a72831
--- /dev/null
+++ b/doc/BUILDINFO.5.txt
@@ -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[]
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 \