summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorScott Horowitz <stonecrest@gmail.com>2007-10-29 21:25:30 -0600
committerDan McGee <dan@archlinux.org>2007-10-29 22:47:48 -0500
commitaea45a8b20c786358cfe782b4e3ac37c7d9dbe37 (patch)
tree1435a8e733d9da9c5961849fdcf88e3e364eb765 /doc
parentdede5371e7c11ceb6ea36ba770672d61aa9b9002 (diff)
Small updates to documentation.
Signed-off-by: Scott Horowitz <stonecrest@gmail.com> Signed-off-by: Dan McGee <dan@archlinux.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/PKGBUILD.5.txt76
-rw-r--r--doc/makepkg.8.txt18
2 files changed, 81 insertions, 13 deletions
diff --git a/doc/PKGBUILD.5.txt b/doc/PKGBUILD.5.txt
index be3f1169..a66efa5d 100644
--- a/doc/PKGBUILD.5.txt
+++ b/doc/PKGBUILD.5.txt
@@ -36,9 +36,10 @@ Options and Directives
The version of the software as released from the author (e.g. \'2.7.1').
*pkgrel*::
- This is the release number specific to the Arch Linuxs 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
- flags, for example.
+ flags, for example. A pkgrel of 1 is typically used for each upstream
+ software release and is incremented for intermediate PKGBUILD updates.
*pkgdesc*::
This should be a brief description of the package and its functionality.
@@ -71,7 +72,9 @@ Options and Directives
must either reside in the same directory as the PKGBUILD file, or be a
fully-qualified URL that makepkg will use to download the file. In order
to make the PKGBUILD as useful as possible, use the $pkgname and $pkgver
- variables if possible when specifying the download location.
+ variables if possible when specifying the download location. Any files
+ that are compressed will automatically be extracted, unless found in
+ the noextract array listed below.
*noextract (array)*::
An array of filenames corresponding to those from the source array. Files
@@ -191,7 +194,7 @@ Install/Upgrade/Remove Scripting
--------------------------------
Pacman has the ability to store and execute a package-specific script when it
installs, removes, or upgrades a package. This allows a package to configure
-itself after installation and do the opposite right before it is removed.
+itself after installation and perform an opposite action upon removal.
The exact time the script is run varies with each operation:
@@ -218,14 +221,71 @@ same directory as the PKGBUILD script. Then use the install directive:
install=pkgname.install
-The install script does not need to be specified in the source array. A template
-install file is available in the ABS tree (/var/abs/install.proto).
+The install script does not need to be specified in the source array. A
+template install file is available in the ABS tree (/var/abs/install.proto).
+Development Directives
+----------------------
+makepkg supports building development versions of packages without having to
+manually update the pkgver in the PKGBUILD. This was formerly done using the
+separate utility 'versionpkg'. In order to utilize this functionality, your
+PKGBUILD must use correct variable names depending on the SCM being fetched
+from.
+
+*CVS*::
+ The generated pkgver will be the date the package is built.
+
+ *_cvsroot*;;
+ The root of the CVS repository.
+
+ *_cvsmod*;;
+ The CVS module to fetch.
+
+*SVN*::
+ The generated pkgver will be the latest SVN revision number.
+
+ *_svntrunk*;;
+ The trunk of the SVN repository.
+
+ *_cvsmod*;;
+ The SVN module to fetch.
+
+*Git*::
+ The generated pkgver will be one formatted by the 'git-describe'
+ command, with '-' characters converted to '_' characters.
+
+ *_gitroot*;;
+ The URL (all protocols supported) to the GIT repository.
+
+ *_gitname*;;
+ GIT tag or branch to use.
+
+*Mercurial*::
+ The generated pkgver will be the hg tip revision number.
+
+ *_hgroot*;;
+
+ *_hgrepo*;;
+
+*Darcs*::
+ The generated pkgver will be the date the package is built.
+
+ *_darcstrunk*;;
+
+ *_darcsmod*;;
+
+*Bazaar*::
+ The generated pkgver will be the latest Bazaar revision number (revno).
+
+ *_bzrtrunk*;;
+
+ *_bzrmod*;;
+
Example
-------
-The following is an example PKGBUILD for the 'module-init-tools' package. For more
-examples, look through the ABS tree.
+The following is an example PKGBUILD for the 'module-init-tools' package. For
+more examples, look through the ABS tree.
-----
include::PKGBUILD-example.txt[]
diff --git a/doc/makepkg.8.txt b/doc/makepkg.8.txt
index 02d29f32..b1abd650 100644
--- a/doc/makepkg.8.txt
+++ b/doc/makepkg.8.txt
@@ -60,7 +60,7 @@ Options
*-e, \--noextract*::
Do not extract source files; use whatever source already exists in the
- src/ directory. This is handy if you want to go into src and manually
+ src/ directory. This is handy if you want to go into src/ and manually
patch or tweak code, then make a package out of the result. Keep in mind
that creating a patch may be a better solution to allow others to use
your PKGBUILD.
@@ -94,8 +94,8 @@ Options
building.
*-p* <`buildscript`>::
- Read the package script `buildscript` instead of the default, see
- manlink:PKGBUILD[5].
+ Read the package script `buildscript` instead of the `PKGBUILD` default;
+ see manlink:PKGBUILD[5].
*-r, \--rmdeps*::
Upon successful build, remove any dependencies installed by makepkg
@@ -107,8 +107,8 @@ Options
build itself will not change.
*-s, \--syncdeps*::
- Install missing dependencies using pacman. When missing build-time or
- run-time dependencies are found, pacman will try to resolve them. If
+ Install missing dependencies using pacman. When build-time or run-time
+ dependencies are not found, pacman will try to resolve them. If
successful, the missing packages will be downloaded and installed.
*\--asroot*::
@@ -130,6 +130,14 @@ Options
useful if you are redirecting makepkg output to file.
+Additional Features
+-------------------
+makepkg supports building development versions of packages without having to
+manually update the pkgver in the PKGBUILD. This was formerly done using the
+separate utility 'versionpkg'. See manlink:PKGBUILD[5] for details on how to
+set up a development PKGBUILD.
+
+
Configuration
-------------
See manlink:makepkg.conf[5] for more details on configuring makepkg using the