Difference between revisions of "VCS package guidelines"

From ArchWiki
Jump to: navigation, search
(Guidelines)
(More rant)
Line 28: Line 28:
  
 
=== 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 should be specified in the {{ic|1=source=()}} array and will be treated like any other source. {{ic|makepkg}} will clone/checkout/branch the repo into {{ic|$SRCDEST}} (same as {{ic|$startdir}} if not set in [https://www.archlinux.org/pacman/makepkg.conf.5.html makepkg.conf(5)]) and copy it to {{ic|$srcdir}} (in a specific way to each VCS). The local repo is left untouched, thus invalidating the need for a {{ic|-build}} directory.
 
+
The general format of a VCS source array is as follows:
+
  
 +
The general format of a VCS {{ic|1=source=()}} array is:
 
  source=('[dir::][vcs+]url[#fragment]')
 
  source=('[dir::][vcs+]url[#fragment]')
  
* {{ic|url}} is pretty self-explanatory, this is the URL to the distant repo
+
* {{ic|url}} is the URL to the distant or local repo
 
+
* {{ic|vcs+}} is needed for URLs that do not reflect the VCS type, such as {{ic|http://some_distant_repo}}
{{Note|The URL can also point to a local repo instead of a distant one if so desired.}}
+
* {{ic|#fragment}} is needed to pull a specific branch or commit (see: [https://www.archlinux.org/pacman/makepkg.8.html makepkg(8)] for a list of recognized fragments)
 
+
* {{ic|dir}} is used to change the default repo name to something more relevant (e.g. than {{ic|trunk}}) or to preserve the previous sources
* {{ic|vcs+}} is needed for URLs that do not reflect the VCS type, like {{ic|http://some_distant_repo}}
+
* {{ic|#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 {{ic|dir}} is used to change the default name of the local repo into something more relevant than {{ic|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:
+
  
 +
An example Git source array:
 
  source=('project_name::git+http://project_url#branch=project_branch')
 
  source=('project_name::git+http://project_url#branch=project_branch')
  

Revision as of 16:27, 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 should be specified in the source=() array and will be treated like any other source. makepkg will clone/checkout/branch the repo into $SRCDEST (same as $startdir if not set in makepkg.conf(5)) and copy it to $srcdir (in a specific way to each VCS). The local repo is left untouched, thus invalidating the need for a -build directory.

The general format of a VCS source=() array is:

source=('[dir::][vcs+]url[#fragment]')
  • url is the URL to the distant or local repo
  • vcs+ is needed for URLs that do not reflect the VCS type, such as http://some_distant_repo
  • #fragment is needed to pull a specific branch or commit (see: makepkg(8) for a list of recognized fragments)
  • dir is used to change the default repo name to something more relevant (e.g. than trunk) or to preserve the previous sources

An example Git source array:

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.