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 <[email protected]> --- doc/BUILDINFO.5.txt | 65 +++++++++++++++++++++++++++++++++++++++++++++++++++++ doc/Makefile.am | 4 +++- 2 files changed, 68 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..1a454497 --- /dev/null +++ b/doc/BUILDINFO.5.txt @@ -0,0 +1,65 @@ +///// +vim:set ts=4 sw=4 syntax=asciidoc noet spell spelllang=en_us: +///// +BUILDINFO(5) +============ + +Name +---- +BUILDINFO - Arch Linux package build information file + + +Synopsis +-------- +BUILDINFO + + +Description +----------- +This manual page describes the format of a BUILDINFO file usually found in a +package created by makepkg. + +Contents +-------- +The following is a list of the contents and a description of the key value pairs +in a BUILDINFO file. + +*format*:: + Denotes the file format, represented by a number. + +*pkgname*:: + The name of the package. + +*pkgbase*:: + The name used to refer to the group of packages in the output of makepkg. + +*pkgver*:: + The version of the package including pkgrel and epoch. + +*pkgbuild_sha256sum*:: + The sha256sum 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 from which makepkg has been invoked. + +*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. + +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
