From 076b6184de2b20e9b26225d93f6f3a7030504109 Mon Sep 17 00:00:00 2001
From: Eli Schwartz <eschwartz@archlinux.org>
Date: Thu, 3 May 2018 00:10:21 -0400
Subject: Ensure better text editor automatic filetype detection

Since we no longer use vim-specific modelines, use the .asciidoc file
extension which is, well, reserved for asciidoc formatted files. This
should presumably work everywhere without needing editor-specific
workarounds and configuration.

Also add a shebang to makepkg.conf to indicate it contains bash content.

Signed-off-by: Eli Schwartz <eschwartz@archlinux.org>
Signed-off-by: Allan McRae <allan@archlinux.org>
---
 doc/BUILDINFO.5.asciidoc | 70 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 70 insertions(+)
 create mode 100644 doc/BUILDINFO.5.asciidoc

(limited to 'doc/BUILDINFO.5.asciidoc')

diff --git a/doc/BUILDINFO.5.asciidoc b/doc/BUILDINFO.5.asciidoc
new file mode 100644
index 00000000..3db1e12f
--- /dev/null
+++ b/doc/BUILDINFO.5.asciidoc
@@ -0,0 +1,70 @@
+/////
+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.
+
+*pkgarch*::
+	The architecture of the package.
+
+*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-$pkgarch".
+
+See Also
+--------
+linkman:makepkg[8], linkman:pacman[8], linkman:makepkg.conf[5]
+
+include::footer.asciidoc[]
-- 
cgit v1.2.3-54-g00ecf

