Introduce new PKGBUILD variable `changelog`

Currently, a changelog is added to a package if a specific file with a
hardcoded name exists in the PKGBUILD's directory. This approach is not
pretty and also inconsistent with the handling of install files, but it
works.

With the introduction of split PKGBUILDs, however, a drawback in this
old behavior has arisen: you only have the possibility to include one
specific changelog file in either every package defined in the PKGBUILD
or in none.

The use of an additional variable, `changelog`, works around this issue
and makes it possible to include a changelog in only some of the
packages, and besides, each package of the PKGBUILD can have its own
changelog file.

Signed-off-by: Cedric Staniewski <cedric@gmx.ca>
Signed-off-by: Allan McRae <allan@archlinux.org>
Signed-off-by: Dan McGee <dan@archlinux.org>

1 files changed, 7 insertions, 1 deletions

diff --git a/doc/PKGBUILD.5.txt b/doc/PKGBUILD.5.txt
index e6f6edf5..8d5537e9 100644
--- a/doc/PKGBUILD.5.txt
+++ b/doc/PKGBUILD.5.txt
@@ -79,6 +79,12 @@ similar to `$_basekernver`.
 	be copied into the package by makepkg. It does not need to be included
 	in the source array (e.g. `install=pkgname.install`).
 
+*changelog*::
+	Specifies a changelog file that is to be included in the package.
+	This file should reside in the same directory as the PKGBUILD, and will
+	be copied into the package by makepkg. It does not need to be included
+	in the source array (e.g. `changelog=$pkgname.changelog`).
+
 *source (array)*::
 	An array of source files required to build the package. Source files
 	must either reside in the same directory as the PKGBUILD file, or be a
@@ -271,7 +277,7 @@ All options and directives for the split packages default to the global values g
 within the PKGBUILD. However, some of these can be overridden within each split
 package's packaging function. The following variables can be overridden: `pkgdesc`,
 `license`, `groups`, `depends`, `optdepends`, `provides`, `conflicts`, `replaces`,
-`backup`, `options` and `install`.
+`backup`, `options`, `install` and `changelog`.
 
 An optional global directive is available when building a split package: