Difference between revisions of "VCS package guidelines"

From ArchWiki
Jump to: navigation, search
(A sample Git PKGBUILD for pacman 4.1)
(Blah blah blah.. remove the unnecessary rant making the guidelines more tedious to read)
Line 8: Line 8:
  
 
== Prototypes ==
 
== Prototypes ==
 +
 
The [[ABS]] package provides prototypes for [[cvs]], [[svn]], [[git]], [[mercurial]], and [[Wikipedia:darcs|darcs]] [[PKGBUILD]]s. When {{Pkg|abs}} is installed, you can find them in {{ic|/usr/share/pacman}}. Latest versions can be found in the [https://projects.archlinux.org/abs.git/tree/prototypes prototypes directory in the ABS Git repository].
 
The [[ABS]] package provides prototypes for [[cvs]], [[svn]], [[git]], [[mercurial]], and [[Wikipedia:darcs|darcs]] [[PKGBUILD]]s. When {{Pkg|abs}} is installed, you can find them in {{ic|/usr/share/pacman}}. Latest versions can be found in the [https://projects.archlinux.org/abs.git/tree/prototypes prototypes directory in the ABS Git repository].
  
 
== Guidelines ==
 
== Guidelines ==
* Properly suffix {{Ic|pkgname}} with {{Ic|-cvs}}, {{Ic|-svn}}, {{Ic|-hg}}, {{Ic|-darcs}}, {{Ic|-bzr}}, {{Ic|-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 {{Ic|pkgrel}} is mandatory. If both the revision number and the resulting binary remain the same, {{Ic|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.
+
* Suffix {{Ic|pkgname}} with {{Ic|-cvs}}, {{Ic|-svn}}, {{Ic|-hg}}, {{Ic|-darcs}}, {{Ic|-bzr}}, {{Ic|-git}} etc. unless the package fetches a specific release.
  
* When [[makepkg]] is run, by default it will check for newer revisions and then update the {{Ic|pkgver}} in the PKGBUILD. Look at {{Ic|--holdver}} in [https://www.archlinux.org/pacman/makepkg.8.html man makepkg] if you want otherwise.  {{Ic|--holdver}} only works for cvs and svn, which allow checkout of older revisions.
+
* If the resulting package is different after changing the dependencies, URL, sources, etc. increasing the {{Ic|pkgrel}} is mandatory. Touching the {{ic|pkgver}} isn't.
  
* Check for package conflicts.  For example ''fluxbox-svn'' will conflict with ''fluxbox''.  In this case, you need to use {{Ic|1=conflicts=('fluxbox')}}.
+
* {{Ic|--holdver}} can be used to prevent [[makepkg]] from updating the {{ic|pkgver}} (see: [https://www.archlinux.org/pacman/makepkg.8.html makepkg(8)])
  
* Use the {{Ic|provides}} field so that packages that require the non-VCS package can be installed ({{Ic|1=provides=('fluxbox')}}).
+
* Include what the package conflicts with and provides (e.g. for {{AUR|fluxbox-git}}: {{Ic|1=conflicts=('fluxbox')}} and {{Ic|1=provides=('fluxbox')}}).
  
* You should AVOID using {{Ic|1=replaces}} as it generally causes unnecessary problems.
+
* {{Ic|1=replaces=()}} generally causes unnecessary problems and should be avoided.
  
* 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 the cvsroot, use {{Ic|anonymous:@}} rather than {{Ic|anonymous@}} to avoid having to enter a blank password or {{Ic|anonymous:password@}}, if one is required.
  
* Don't forget to include the appropriate VCS tool (cvs, subversion, git, ...) in {{Ic|1=makedepends}}.
+
* Include the appropriate VCS tool ({{pkg|cvs}}, {{pkg|subversion}}, {{pkg|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:
+
 
+
mkdir "$srcdir/$_vcsname-build"
+
+
cd "$srcdir/$_vcsname-build"
+
../"$_vcsname"/configure
+
 
+
or:
+
 
+
cp -r "$srcdir/$_vcsname" "$srcdir/$_vcsname-build"
+
cd "$srcdir/$_vcsname-build"
+
 
+
* With the introduction of the [[AUR]], it is most important to avoid using backtick execution to create package variables. makepkg will automatically bump the {{Ic|pkgver}} anyway when building the package (unless {{Ic|--holdver}} is used).
+
 
+
== Pacman 4.1 ==
+
  
 
=== VCS sources ===
 
=== VCS sources ===
 
 
Starting with {{Pkg|pacman}} 4.1, the VCS sources are handled differently. They can be specified in the {{ic|source}} array and will be treated like any other source: {{ic|makepkg}} will clone/checkout/branch the distant repo in a subdirectory inside the {{ic|$SRCDEST}} directory defined in {{Ic|/etc/makepkg.conf}}. The directory is then copied (in a way that is specific to each VCS) in {{ic|$srcdir}}, as a result the local repo is left untouched and there is no need for a {{ic|-build}} directory anymore. Any subsequent attempt at building a package will only do incremental updates to the local repo, provided it was not erased.
 
Starting with {{Pkg|pacman}} 4.1, the VCS sources are handled differently. They can be specified in the {{ic|source}} array and will be treated like any other source: {{ic|makepkg}} will clone/checkout/branch the distant repo in a subdirectory inside the {{ic|$SRCDEST}} directory defined in {{Ic|/etc/makepkg.conf}}. The directory is then copied (in a way that is specific to each VCS) in {{ic|$srcdir}}, as a result the local repo is left untouched and there is no need for a {{ic|-build}} directory anymore. Any subsequent attempt at building a package will only do incremental updates to the local repo, provided it was not erased.
  
Line 65: Line 48:
 
  source=('project_name::git+http://project_url#branch=project_branch')
 
  source=('project_name::git+http://project_url#branch=project_branch')
  
=== Bazaar limitation ===
+
=== The pkgver() function ===
 
+
Currently, bazaar URLs can only be as follows:
+
 
+
source=('project_name::bzr+http://bazaar.launchpad.net/~project_team/project_path')
+
 
+
Using any other {{ic|http://}}, {{ic|https://}} or {{ic|ssh://}} URL will prevent makepkg from being able to update the local repo. Additionnally, using {{ic|lp:project_name}} will not work at all.
+
 
+
The correct url can be obtained by running:
+
$ bzr config parent_location
+
or:
+
$ bzr info | grep parent | sed 's|  parent branch: ||'
+
inside the local repo.
+
 
+
=== pkgver autobump ===
+
 
+
 
The {{ic|pkgver}} autobump is now achieved via a dedicated {{ic|pkgver()}} function. This allows for better control over the {{ic|pkgver}}, and maintainers should favor a {{ic|pkgver}} that makes sense. Following are some examples for several VCS.  
 
The {{ic|pkgver}} autobump is now achieved via a dedicated {{ic|pkgver()}} function. This allows for better control over the {{ic|pkgver}}, and maintainers should favor a {{ic|pkgver}} that makes sense. Following are some examples for several VCS.  
  
 
==== Git ====
 
==== Git ====
 
 
With tags:
 
With tags:
  
Line 107: Line 74:
  
 
==== Subversion ====
 
==== Subversion ====
 
 
  pkgver() {
 
  pkgver() {
 
   cd "$SRCDEST"/local_repo
 
   cd "$SRCDEST"/local_repo
Line 116: Line 82:
  
 
==== Mercurial ====
 
==== Mercurial ====
 
 
  pkgver() {
 
  pkgver() {
 
   cd "$srcdir"/local_repo
 
   cd "$srcdir"/local_repo
Line 123: Line 88:
  
 
==== Bazaar ====
 
==== Bazaar ====
 
 
  pkgver() {
 
  pkgver() {
 
   cd "$srcdir"/local_repo
 
   cd "$srcdir"/local_repo
Line 130: Line 94:
  
 
==== Fallback ====
 
==== Fallback ====
 
 
The following can be used in case no satisfactory {{ic|pkgver}} can be extracted from the repo.
 
The following can be used in case no satisfactory {{ic|pkgver}} can be extracted from the repo.
  
Line 138: Line 101:
  
 
== Tips ==
 
== Tips ==
 +
 
=== Removing SVN leftovers ===
 
=== Removing SVN leftovers ===
 
You should make sure that there are no SVN 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()}} function:
 
You should make sure that there are no SVN 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()}} function:
Line 144: Line 108:
  
 
=== A sample Git PKGBUILD for pacman 4.1 ===
 
=== A sample Git PKGBUILD for pacman 4.1 ===
 
 
  # Contributor: Dave Reisner <d@falconindy.com>  
 
  # Contributor: Dave Reisner <d@falconindy.com>  
 
  # Edited for pacman 4.1 by William Giokas (KaiSforza) <1007380@gmail.com>
 
  # Edited for pacman 4.1 by William Giokas (KaiSforza) <1007380@gmail.com>
Line 188: Line 151:
 
   make PREFIX=/usr DESTDIR="$pkgdir" install
 
   make PREFIX=/usr DESTDIR="$pkgdir" install
 
  }
 
  }
 +
 +
== Troubleshooting ==
 +
 +
=== Bazaar limitation ===
 +
Currently, bazaar URLs can only be as follows:
 +
 +
source=('project_name::bzr+http://bazaar.launchpad.net/~project_team/project_path')
 +
 +
Using any other {{ic|http://}}, {{ic|https://}} or {{ic|ssh://}} URL will prevent makepkg from being able to update the local repo. Additionnally, using {{ic|lp:project_name}} will not work at all.
 +
 +
The correct url can be obtained by running:
 +
$ bzr config parent_location
 +
or:
 +
$ bzr info | grep parent | sed 's|  parent branch: ||'
 +
inside the local repo.

Revision as of 15:59, 7 April 2013

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

  • Suffix pkgname with -cvs, -svn, -hg, -darcs, -bzr, -git etc. unless the package fetches a specific release.
  • If the resulting package is different after changing the dependencies, URL, sources, etc. increasing the pkgrel is mandatory. Touching the pkgver isn't.
  • Include what the package conflicts with and provides (e.g. for fluxbox-gitAUR: conflicts=('fluxbox') and provides=('fluxbox')).
  • replaces=() generally causes unnecessary problems and should be avoided.
  • When using the cvsroot, use anonymous:@ rather than anonymous@ to avoid having to enter a blank password or anonymous:password@, if one is required.

VCS sources

Starting with pacman 4.1, the VCS sources are handled differently. They can be specified in the source array and will be treated like any other source: makepkg will clone/checkout/branch the distant repo in a subdirectory inside the $SRCDEST directory defined in /etc/makepkg.conf. The directory is then copied (in a way that is specific to each VCS) in $srcdir, as a result the local repo is left untouched and there is no need for a -build directory anymore. Any subsequent attempt at building a package will only do incremental updates to the local repo, provided it was not erased.

The general format of a VCS source array is as follows:

source=('[dir::][vcs+]url[#fragment]')
  • url is pretty self-explanatory, this is the URL to the distant repo
Note: The URL can also point to a local repo instead of a distant one if so desired.
  • vcs+ is needed for URLs that do not reflect the VCS type, like http://some_distant_repo
  • #fragment is an optional parameter which can be used to pull a specific branch or commit. The list of recognized fragments is documented in the PKGBUILD manpage
  • finally dir is used to change the default name of the local repo into something more relevant than trunk for example
Note: This is useful in case you want to keep several local repos lying around.

Here is an example of what a git source array could look like:

source=('project_name::git+http://project_url#branch=project_branch')

The pkgver() function

The pkgver autobump is now achieved via a dedicated pkgver() function. This allows for better control over the pkgver, and maintainers should favor a pkgver that makes sense. Following are some examples for several VCS.

Git

With tags:

pkgver() {
  cd "$srcdir"/local_repo
  git describe --always | sed 's|-|.|g'
}

Without tags:

pkgver() {
  cd "$srcdir"/local_repo
  echo "0.$(git rev-list --count HEAD).$(git describe --always)"
}

Using the last commit date:

pkgver() {
  cd "$srcdir"/local_repo
  git log -1 --format="%cd" --date=short | sed 's|-||g'
}

Subversion

pkgver() {
  cd "$SRCDEST"/local_repo
  svnversion
}
Note: The copy inside $srcdir is made using svn export which does not create working copies, any svn related command has to be used in the local repo, hence $SRCDEST.

Mercurial

pkgver() {
  cd "$srcdir"/local_repo
  hg identify -ni | awk 'BEGIN{OFS=".";} {print $2,$1}'
}

Bazaar

pkgver() {
  cd "$srcdir"/local_repo
  bzr revno
}

Fallback

The following can be used in case no satisfactory pkgver can be extracted from the repo.

pkgver() {
  date +"%Y%m%d"
}

Tips

Removing SVN leftovers

You should make sure that there are no SVN 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() function:

$ find "$pkgdir" -type d -name ".svn" -exec rm -rf '{}' +;

A sample Git PKGBUILD for pacman 4.1

# Contributor: Dave Reisner <d@falconindy.com> 
# Edited for pacman 4.1 by William Giokas (KaiSforza) <1007380@gmail.com>

pkgname=expac-git
_gitname=expac
pkgver=0.0.0
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')
# or:
#source=('git+https://github.com/falconindy/expac.git')
# because the sources are not static, skip checksums
md5sums=('SKIP')

pkgver() {
  cd "$srcdir/$_gitname"
  git describe --always | sed 's|-|.|g'
  # To give the total count of commits and the hash of the last one:
  # (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):
  #echo "0.$(git rev-list --count $branch).$(git describe --always)"
  # Using the last commit date:
  #git log -1 --format="%cd" --date=short | sed 's|-||g'
}

build() {
  cd "$srcdir/$_gitname"
  make
}

package() {
  cd "$srcdir/$_gitname"
  make PREFIX=/usr DESTDIR="$pkgdir" install
}

Troubleshooting

Bazaar limitation

Currently, bazaar URLs can only be as follows:

source=('project_name::bzr+http://bazaar.launchpad.net/~project_team/project_path')

Using any other http://, https:// or ssh:// URL will prevent makepkg from being able to update the local repo. Additionnally, using lp:project_name will not work at all.

The correct url can be obtained by running:

$ bzr config parent_location

or:

$ bzr info | grep parent | sed 's|  parent branch: ||'

inside the local repo.