diff mbox

[pacman-dev] PKGBUILD.5: document restriction on pkgrel

Message ID 20180604125002.2806-1-allan@archlinux.org
State Accepted, archived
Headers show

Commit Message

Allan McRae June 4, 2018, 12:50 p.m. UTC
The format of pkgrel was much more retrictive than described in the
man page. Update the documentation to reflect this.

Signed-off-by: Allan McRae <allan@archlinux.org>
---

Is this explanation clear?  We also need to update the error message from
lint_pkgrel to be more accurate.

 doc/PKGBUILD.5.asciidoc | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
diff mbox

Patch

diff --git a/doc/PKGBUILD.5.asciidoc b/doc/PKGBUILD.5.asciidoc
index ac26f3fe..b7e07165 100644
--- a/doc/PKGBUILD.5.asciidoc
+++ b/doc/PKGBUILD.5.asciidoc
@@ -56,11 +56,13 @@  new `pkgver`.  This is most useful when used with sources from version control
 systems (see below).
 
 *pkgrel*::
-	This is the release number specific to the Arch Linux release. This
+	This is the release number specific to the distribution. This
 	allows package maintainers to make updates to the package's configure
 	flags, for example. This is typically set to '1' for each new upstream
 	software release and incremented for intermediate PKGBUILD updates. The
-	variable is not allowed to contain hyphens.
+	variable is a postive integer, with an optional subrelease level
+	specified by adding another postive integer separated by a period
+	(i.e. in the form x.y).
 
 *epoch*::
 	Used to force the package to be seen as newer than any previous versions