Difference between revisions of "VCS package guidelines"
(→Guidelines) |
m (Spelling) |
||
(4 intermediate revisions by 3 users not shown) | |||
Line 21: | Line 21: | ||
* Use the {{Ic|provides}} field so that packages that require the non-VCS package can be installed ({{Ic|1=provides=('fluxbox')}}). | * Use the {{Ic|provides}} field so that packages that require the non-VCS package can be installed ({{Ic|1=provides=('fluxbox')}}). | ||
− | * You should AVOID using {{Ic|1=replaces | + | * You should AVOID using {{Ic|1=replaces}} as it generally causes unnecessary problems. |
* When using/defining the cvsroot, use {{Ic|anonymous:@}} rather than {{Ic|anonymous@}} to avoid a password prompt and having to enter a blank password ''OR'' use {{Ic|anonymous:password@}} if a password is required. | * When using/defining the cvsroot, use {{Ic|anonymous:@}} rather than {{Ic|anonymous@}} to avoid a password prompt and having to enter a blank password ''OR'' use {{Ic|anonymous:password@}} if a password is required. | ||
− | * Don't forget to include the appropriate VCS tool (cvs, subversion, git, ...) in {{Ic|1=makedepends | + | * Don't forget to include the appropriate VCS tool (cvs, subversion, git, ...) in {{Ic|1=makedepends}}. |
* To preserve the integrity of the checked-out code consider copying the original build directory if you have to make edits. For example, having checked out source code to {{ic|$srcdir/$_vcsname}} from a host you can use: | * To preserve the integrity of the checked-out code consider copying the original build directory if you have to make edits. For example, having checked out source code to {{ic|$srcdir/$_vcsname}} from a host you can use: | ||
Line 38: | Line 38: | ||
cp -r "$srcdir/$_vcsname" "$srcdir/$_vcsname-build" | cp -r "$srcdir/$_vcsname" "$srcdir/$_vcsname-build" | ||
cd "$srcdir/$_vcsname-build" | cd "$srcdir/$_vcsname-build" | ||
+ | |||
+ | {{Note|[https://mailman.archlinux.org/pipermail/pacman-dev/2013-February/016523.html The timetable for pacman 4.1 was just announced on pacman-dev.]}} | ||
If you are using pacman 4.1 (currently the development version) then this is no longer needed. Pacman works with vcs sources in a totally different way. | If you are using pacman 4.1 (currently the development version) then this is no longer needed. Pacman works with vcs sources in a totally different way. | ||
Line 44: | Line 46: | ||
* Starting with pacman 4.1, there vcs sources are handled more similarly to other sources. This removes the need for a {{Ic|-build}} directory. A quick explanation of what pacman does now using git as an example: | * Starting with pacman 4.1, there vcs sources are handled more similarly to other sources. This removes the need for a {{Ic|-build}} directory. A quick explanation of what pacman does now using git as an example: | ||
− | ** makepkg sees that the source is a vcs (in this case git) source in the source | + | ** makepkg sees that the source is a vcs (in this case git) source in the {{ic|source}} array in two ways: either the url is a {{Ic|git://}} url or the source is written as {{Ic|git+https://}} |
*** Sources can be specified in a few ways: Either the url is obviously a vcs url ({{Ic|git://}}, etc.) or the url is preceded by the type of vcs used ({{Ic|git+https://}}) | *** Sources can be specified in a few ways: Either the url is obviously a vcs url ({{Ic|git://}}, etc.) or the url is preceded by the type of vcs used ({{Ic|git+https://}}) | ||
*** Each vcs has its quirks, but you can specify branches and tags in the source using {{Ic|git://git.url/project.git#branch=branchname}} | *** Each vcs has its quirks, but you can specify branches and tags in the source using {{Ic|git://git.url/project.git#branch=branchname}} | ||
Line 51: | Line 53: | ||
** After the sources have been cloned, a new, non-bare repository is made in the {{Ic|src}} directory, and this is what is worked on. | ** After the sources have been cloned, a new, non-bare repository is made in the {{Ic|src}} directory, and this is what is worked on. | ||
− | * As of pacman 4.1, pkgver gets some special treatment. If pkgver | + | * As of pacman 4.1, pkgver gets some special treatment. If {{ic|pkgver}} is empty, makepkg looks for a {{ic|pkgver()}} function. This can be one of many things, outlined below: |
− | Generic pkgver function: | + | Generic {{ic|pkgver}} function: |
pkgver () { | pkgver () { | ||
echo $(date +%Y%m%d) | echo $(date +%Y%m%d) | ||
} | } | ||
− | Git specific pkgver function: | + | Git specific {{ic|pkgver}} function: |
pkgver () { | pkgver () { | ||
cd "$srcdir/$_gitname" | cd "$srcdir/$_gitname" | ||
echo $(git describe --always | sed 's/-/./g') | echo $(git describe --always | sed 's/-/./g') | ||
} | } | ||
− | Mercurial pkgver function: | + | Mercurial {{ic|pkgver}} function: |
pkgver() { | pkgver() { | ||
cd "$srcdir/$_hgrepo" | cd "$srcdir/$_hgrepo" | ||
Line 68: | Line 70: | ||
== Tips == | == Tips == | ||
− | * You should make sure that there are no VCS directories and files left over in your package. If there are, you may want to remove them, by adding a command similar to this one at the end of the the package() script: | + | * You should make sure that there are no VCS directories and files left over in your package. If there are, you may want to remove them, by adding a command similar to this one at the end of the the {{ic|package()}} script: |
rm -rf $(find "$pkgdir" -type d -name ".svn") | rm -rf $(find "$pkgdir" -type d -name ".svn") | ||
Line 86: | Line 88: | ||
cd "$srcdir" | cd "$srcdir" | ||
msg "Connecting to GIT server..." | msg "Connecting to GIT server..." | ||
− | if [ -d $_gitname ] ; then | + | if [ -d "$_gitname" ] ; then |
− | cd $_gitname && git pull origin | + | cd "$_gitname" && git pull origin |
+ | cd "$srcdir" | ||
msg "The local files are updated." | msg "The local files are updated." | ||
else | else | ||
− | git clone --depth=1 $_gitroot $_gitname | + | git clone --depth=1 "$_gitroot" "$_gitname" |
fi | fi | ||
msg "GIT checkout done or server timeout" | msg "GIT checkout done or server timeout" | ||
− | * Here is an example of a | + | * Here is an example of a Git PKGBUILD in pacman 4.1: |
# Contributor: Dave Reisner <d@falconindy.com> | # Contributor: Dave Reisner <d@falconindy.com> |
Revision as of 05:44, 24 February 2013
zh-CN:VCS PKGBUILD Guidelines zh-TW:VCS PKGBUILD Guidelines Template:Package Guidelines
Version control systems can be used for retrieval of source code for both usual statically versioned packages and latest (trunk) version of packages. This article covers both cases.
Prototypes
The ABS package provides prototypes for cvs, svn, git, mercurial, and darcs PKGBUILDs. When abs is installed, you can find them in /usr/share/pacman
. Latest versions can be found in the prototypes directory in the ABS Git repository.
Guidelines
- Properly suffix
pkgname
with-cvs
,-svn
,-hg
,-darcs
,-bzr
,-git
etc. If the package tracks a moving development trunk it should be given a suffix. If the package fetches a release from a VCS tag then it should not be given a suffix. Use this rule of thumb: if the output of the package depends on the time at which it was compiled, append a suffix; otherwise do not.
- A VCS package may be updated as and when needed to adopt changes to the build system, including ammendments to dependencies, URL, sources, etc. If the revision number remains the same after such an update, but produces a resulting binary which is different, increasing the
pkgrel
is mandatory. If both the revision number and the resulting binary remain the same,pkgrel
should be kept intact. There is no need to update the VCS package just to accommodate a revision bump, but one may choose to do so.
- When makepkg is run, by default it will check for newer revisions and then update the
pkgver
in the PKGBUILD. Look at--holdver
in man makepkg if you want otherwise.--holdver
only works for cvs and svn, which allow checkout of older revisions.
- Check for package conflicts. For example fluxbox-svn will conflict with fluxbox. In this case, you need to use
conflicts=('fluxbox')
.
- Use the
provides
field so that packages that require the non-VCS package can be installed (provides=('fluxbox')
).
- You should AVOID using
replaces
as it generally causes unnecessary problems.
- When using/defining the cvsroot, use
anonymous:@
rather thananonymous@
to avoid a password prompt and having to enter a blank password OR useanonymous:password@
if a password is required.
- Don't forget to include the appropriate VCS tool (cvs, subversion, git, ...) in
makedepends
.
- To preserve the integrity of the checked-out code consider copying the original build directory if you have to make edits. For example, having checked out source code to
$srcdir/$_vcsname
from a host you can use:
mkdir "$srcdir/$_vcsname-build" cd "$srcdir/$_vcsname-build" ../"$_vcsname"/configure
or:
cp -r "$srcdir/$_vcsname" "$srcdir/$_vcsname-build" cd "$srcdir/$_vcsname-build"
If you are using pacman 4.1 (currently the development version) then this is no longer needed. Pacman works with vcs sources in a totally different way.
- With the introduction of the AUR, it is most important to avoid using backtick execution to create package variables. makepkg will automatically bump the
pkgver
anyway when building the package (unless--holdver
is used).
- Starting with pacman 4.1, there vcs sources are handled more similarly to other sources. This removes the need for a
-build
directory. A quick explanation of what pacman does now using git as an example:- makepkg sees that the source is a vcs (in this case git) source in the
source
array in two ways: either the url is agit://
url or the source is written asgit+https://
- Sources can be specified in a few ways: Either the url is obviously a vcs url (
git://
, etc.) or the url is preceded by the type of vcs used (git+https://
) - Each vcs has its quirks, but you can specify branches and tags in the source using
git://git.url/project.git#branch=branchname
- Sources can be specified in a few ways: Either the url is obviously a vcs url (
- The repository is cloned into a bare repository (check the git documentation for a more detailed explanation).
- Because git already checks for integrity, you should use
'SKIP'
in the checksum. This concludes getting the sources. - After the sources have been cloned, a new, non-bare repository is made in the
src
directory, and this is what is worked on.
- makepkg sees that the source is a vcs (in this case git) source in the
- As of pacman 4.1, pkgver gets some special treatment. If
pkgver
is empty, makepkg looks for apkgver()
function. This can be one of many things, outlined below:
Generic pkgver
function:
pkgver () { echo $(date +%Y%m%d) }
Git specific pkgver
function:
pkgver () { cd "$srcdir/$_gitname" echo $(git describe --always | sed 's/-/./g') }
Mercurial pkgver
function:
pkgver() { cd "$srcdir/$_hgrepo" hg identify -ni | awk 'BEGIN{OFS=".";} {print $2,$1}' }
Tips
- You should make sure that there are no VCS directories and files left over in your package. If there are, you may want to remove them, by adding a command similar to this one at the end of the the
package()
script:
rm -rf $(find "$pkgdir" -type d -name ".svn")
- When using Git, one can speed up the cloning operation using the
--depth=1
parameter. This creates a shallow clone, and has only the last change history - since histories are unimportant for builds most of the time.
git clone git://hostname.dom/project.git --depth=1
- It's possible to create the package also from a branch other than the master. To do so add
--branch branch_name
after the firstgit clone
, in this way:
git clone "$_gitroot" "$_gitname" --branch branch_name
Remember to save package with a different name, for example pkgname-branchname-git
, in order to avoid confusion with the package from the branch master.
- Copy paste script when building from repo
If you are lazy here is a sample script when making git-based PKGBUILDs. This is not needed if you are using pacman 4.1 or later.
cd "$srcdir" msg "Connecting to GIT server..." if [ -d "$_gitname" ] ; then cd "$_gitname" && git pull origin cd "$srcdir" msg "The local files are updated." else git clone --depth=1 "$_gitroot" "$_gitname" fi msg "GIT checkout done or server timeout"
- Here is an example of a Git PKGBUILD in pacman 4.1:
# Contributor: Dave Reisner <d@falconindy.com> # Edited for pacman 4.1 by William Giokas (KaiSforza) <1007380@gmail.com> pkgname=expac-git pkgver= pkgrel=1 pkgdesc="pacman database extraction utility" arch=('i686' 'x86_64') url="http://github.com/falconindy/expac" license=('MIT') depends=('pacman') makedepends=('git' 'perl') conflicts=('expac') provides=('expac') # here is the fun bit. makepkg knows it's a git repo because the url starts with 'git' # it then knows to checkout the branch 'pacman41' upon cloning, expediating versioning. source=("git://github.com/falconindy/expac.git#branch=pacman41") # because the sources are not static, skip checksums md5sums=('SKIP') _gitname="expac" pkgver() { cd "$srcdir/$_gitname" echo $(git describe --always | sed 's/-/./g') # for git, if the repo has no tags, comment out the above and uncommnet the next line: #echo "$(git shortlog | grep -c '\s\+').$(git describe --always)" # This will give you a count of the total commits and the hash of the commit you are on. # Useful if you're making a repository with git packages so that they can have sequential # version numbers. (Else a pacman -Syu may not update the package) } build() { cd "$srcdir/$_gitname" make } package() { cd "$srcdir/$_gitname" make PREFIX=/usr DESTDIR="$pkgdir" install }
- Temporary build directories: When using Git, and where you need to create a separate build directory (e.g., for building/compiling), you should avoid copying over the
.git
directory located in the parent folder because it contains history information that Git uses internally. With repos with thousands of commits, this .git directory will contain upwards of hundreds of MiB of useless commit history that has *nothing* to do with the current working tree. The only time you'd need to copy over the .git directory itself is when you need to build from a specific, older commit (which is generally never the case as the point of a VCS PKGBUILD is to pull from the latest bleeding edge commit). Thus, instead of
rm -rf "$srcdir/$_gitname-build" cp -R "$srcdir/$_gitname" "$srcdir/$_gitname-build" # copy everything, including the useless .git folder cd "$srcdir/$_gitname-build" make # build/compile from source
you should do
rm -rf "$srcdir/$_gitname-build" cd "$srcdir/$_gitname" && ls -A | grep -v .git | xargs -d '\n' cp -r -t ../$_gitname-build # do not copy over the .git folder cd "$srcdir/$_gitname-build" make # build/compile from source
to cut down on build time and disk usage. As of pacman 4.1, this is obsolete.