Update documentation to reflect new epoch package variable

Signed-off-by: Dan McGee <dan@archlinux.org>
This commit is contained in:
Dan McGee 2010-10-08 08:52:14 -05:00
parent feb9889f22
commit 42893e7165
2 changed files with 15 additions and 10 deletions

View File

@ -50,7 +50,7 @@ similar to `$_basekernver`.
*pkgrel*:: *pkgrel*::
This is the release number specific to the Arch Linux release. This This is the release number specific to the Arch Linux release. This
allows package maintainers to make updates to the package's configure allows package maintainers to make updates to the package's configure
flags, for example. A pkgrel of 1 is typically used for each upstream flags, for example. A pkgrel of '1' is typically used for each upstream
software release and is incremented for intermediate PKGBUILD updates. The software release and is incremented for intermediate PKGBUILD updates. The
variable is not allowed to contain hyphens. variable is not allowed to contain hyphens.
@ -58,6 +58,15 @@ similar to `$_basekernver`.
This should be a brief description of the package and its functionality. This should be a brief description of the package and its functionality.
Try to keep the description to one line of text. Try to keep the description to one line of text.
*epoch*::
Used to force the package to be seen as newer than any previous versions
with a lower epoch, even if the version number would normally not trigger
such an upgrade. This value is required to be a positive integer; the
default value if left unspecified is '0'. This is useful when the version
numbering scheme of a package changes (or is alphanumeric), breaking normal
version comparison logic. See linkman:pacman[8] for more information on
version comparisons.
*url*:: *url*::
This field contains a URL that is associated with the software being This field contains a URL that is associated with the software being
packaged. This is typically the project's website. packaged. This is typically the project's website.
@ -186,8 +195,8 @@ name. The syntax is: `source=('filename::url')`.
in the options array. To reverse the default behavior, place an ``!'' at in the options array. To reverse the default behavior, place an ``!'' at
the front of the option. Only specify the options you specifically want the front of the option. Only specify the options you specifically want
to override, the rest will be taken from linkman:makepkg.conf[5]. to override, the rest will be taken from linkman:makepkg.conf[5].
*NOTE:* 'force' is a special option only used in a linkman:PKGBUILD[5], *NOTE:* 'force' is a now-removed option in favor of the top level 'epoch'
do not use it unless you know what you are doing. variable.
*strip*;; *strip*;;
Strip symbols from binaries and libraries. If you frequently Strip symbols from binaries and libraries. If you frequently
@ -224,13 +233,6 @@ name. The syntax is: `source=('filename::url')`.
`!makeflags` with select packages that have problems building with `!makeflags` with select packages that have problems building with
custom makeflags such as `-j2` (or higher). custom makeflags such as `-j2` (or higher).
*force*;;
Force the package to be upgraded by a pacman system upgrade
operation, even if the version number would normally not trigger
such an upgrade. This is useful when the version numbering scheme
of a package changes (or is alphanumeric). See linkman:pacman[8] for
more information on version comparisons.
build() Function build() Function
---------------- ----------------

View File

@ -79,6 +79,9 @@ to determine which packages need upgrading. This behavior operates as follows:
1.0a < 1.0alpha < 1.0b < 1.0beta < 1.0p < 1.0pre < 1.0rc < 1.0 1.0a < 1.0alpha < 1.0b < 1.0beta < 1.0p < 1.0pre < 1.0rc < 1.0
Numeric: Numeric:
1 < 1.0 < 1.1 < 1.1.1 < 1.2 < 2.0 < 3.0.0 1 < 1.0 < 1.1 < 1.1.1 < 1.2 < 2.0 < 3.0.0
+
Additionally, packages can have an 'epoch' value defined that will override any
version comparison and force an upgrade.
*-T, \--deptest*:: *-T, \--deptest*::
Check dependencies; this is useful in scripts such as makepkg to check Check dependencies; this is useful in scripts such as makepkg to check