Difference between revisions of "VCS package guidelines"

From ArchWiki
Jump to: navigation, search
(Git: master -> HEAD so it works by default for other branch names)
m (Git: fix path, it is the same as in previous examples (reported in Talk:VCS package guidelines#git pkgver() typo))
 
(113 intermediate revisions by 30 users not shown)
Line 1: Line 1:
 
[[Category:Package development]]
 
[[Category:Package development]]
[[it:VCS PKGBUILD Guidelines]]
+
[[it:VCS package guidelines]]
[[zh-CN:VCS PKGBUILD Guidelines]]
+
[[ja:VCS PKGBUILD ガイドライン]]
[[zh-TW:VCS PKGBUILD Guidelines]]
+
[[zh-cn:VCS package guidelines]]
{{Package Guidelines}}
+
[[zh-tw:VCS package guidelines]]
 +
{{Package guidelines}}
  
[[Wikipedia:Revision_control|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.
+
[[Wikipedia:Revision_control|Version control systems]] can be used for retrieval of source code for both usual statically versioned packages and latest (trunk) version of a development branch. This article covers both cases.
  
 
== 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].
+
Use only the PKGBUILD prototypes provided in the {{Pkg|pacman}} package ({{ic|PKGBUILD-split.proto}}, {{ic|PKGBUILD-vcs.proto}} and {{ic|PKGBUILD.proto}} in {{ic|/usr/share/pacman}}). The prototypes files in the {{Pkg|abs}} package and in [https://projects.archlinux.org/abs.git/tree/prototypes the ABS git repository] are significantly out of date and should not be used.  See {{Bug|34485}}.
  
 
== Guidelines ==
 
== Guidelines ==
Line 15: Line 16:
 
* Suffix {{Ic|pkgname}} with {{Ic|-cvs}}, {{Ic|-svn}}, {{Ic|-hg}}, {{Ic|-darcs}}, {{Ic|-bzr}}, {{Ic|-git}} etc. unless the package fetches a specific release.
 
* Suffix {{Ic|pkgname}} with {{Ic|-cvs}}, {{Ic|-svn}}, {{Ic|-hg}}, {{Ic|-darcs}}, {{Ic|-bzr}}, {{Ic|-git}} etc. unless the package fetches a specific release.
  
* 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.
+
* If the resulting package is different after changing the dependencies, URL, sources, etc. increasing the {{Ic|pkgrel}} is mandatory. Touching the {{ic|pkgver}} is not.
  
 
* {{Ic|--holdver}} can be used to prevent [[makepkg]] from updating the {{ic|pkgver}} (see: [https://www.archlinux.org/pacman/makepkg.8.html makepkg(8)])
 
* {{Ic|--holdver}} can be used to prevent [[makepkg]] from updating the {{ic|pkgver}} (see: [https://www.archlinux.org/pacman/makepkg.8.html makepkg(8)])
Line 26: Line 27:
  
 
* Include the appropriate VCS tool in {{Ic|1=makedepends=()}} ({{pkg|cvs}}, {{pkg|subversion}}, {{pkg|git}}, ...).
 
* Include the appropriate VCS tool in {{Ic|1=makedepends=()}} ({{pkg|cvs}}, {{pkg|subversion}}, {{pkg|git}}, ...).
 +
 +
* Because the sources are not static, skip the checksum in {{ic|1=md5sums=()}} by adding {{ic|'SKIP'}}.
  
 
=== VCS sources ===
 
=== VCS sources ===
 
{{Note|Pacman 4.1 supports the following VCS sources: {{ic|bzr}}, {{ic|git}}, {{ic|hg}} and {{ic|svn}}. See the {{ic|fragment}} section of {{ic|man PKGBUILD}} or [https://www.archlinux.org/pacman/PKGBUILD.5.html PKGBUILD(5)] for a list of supported VCS.}}
 
{{Note|Pacman 4.1 supports the following VCS sources: {{ic|bzr}}, {{ic|git}}, {{ic|hg}} and {{ic|svn}}. See the {{ic|fragment}} section of {{ic|man PKGBUILD}} or [https://www.archlinux.org/pacman/PKGBUILD.5.html PKGBUILD(5)] for a list of supported VCS.}}
  
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.
+
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 repository 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 repository is left untouched, thus invalidating the need for a {{ic|-build}} directory.
  
 
The general format of a VCS {{ic|1=source=()}} array is:
 
The general format of a VCS {{ic|1=source=()}} array is:
 
  source=('[folder::][vcs+]url[#fragment]')
 
  source=('[folder::][vcs+]url[#fragment]')
  
* {{ic|folder}} (optional) is used to change the default repo name to something more relevant (e.g. than {{ic|trunk}}) or to preserve the previous sources
+
* {{ic|folder}} (optional) is used to change the default repository 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, e.g. {{ic|git+http://some_repo}}.
+
* {{ic|vcs+}} is needed for URLs that do not reflect the VCS type, e.g. {{ic|<nowiki>git+http://some_repo</nowiki>}}.
* {{ic|url}} is the URL to the distant or local repo
+
* {{ic|url}} is the URL to the distant or local repository.
* {{ic|#fragment}} (optional) is needed to pull a specific branch or commit
+
* {{ic|#fragment}} (optional) is needed to pull a specific branch or commit. See {{ic|man PKGBUILD}} for more information on the fragments available for each VCS.
  
 
An example Git source array:
 
An example Git source array:
  source=('project_name::git+http://project_url#branch=project_branch')
+
  <nowiki>source=('project_name::git+http://project_url#branch=project_branch')</nowiki>
  
 
=== The pkgver() function ===
 
=== The pkgver() function ===
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 showing the ''intended'' output:
+
 
 +
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. To use {{ic|pkgver()}}, you still need to declare the {{ic|pkgver}} variable with the most recent value. makepkg will invoke function {{ic|pkgver()}}, and update variable {{ic|pkgver}} accordingly.
 +
 
 +
It is recommended to have following version format: ''RELEASE.rREVISION'' where ''REVISION'' is a monotonically increasing number that uniquely identifies the source tree (VCS revisions do this). If there are no public releases and no repository tags then zero could be used as a release number or you can drop ''RELEASE'' completely and use version number that looks like ''rREVISION''. If there are public releases but repo has no tags then the developer should get the release version somehow e.g. by parsing the project files.
 +
 
 +
The revision number delimiter ("r" right before REVISION) is important. This delimiter allows to avoid problems in case if upstream decides to make its first release or uses versions with different number of components. E.g. if at revision "455" upstream decides to release version 0.1 then the revision delimiter preserves version monotonicity - {{ic|0.1.r456 > r454}}. Without the delimiter monotonicity fails - {{ic|0.1.456 < 454}}.
 +
 
 +
See [https://projects.archlinux.org/pacman.git/tree/proto/PKGBUILD-vcs.proto#n33 PKGBUILD-vcs.proto] for generic examples showing the intended output.
  
 
==== Git ====
 
==== Git ====
  
Using the tag of the last commit:
+
Using the most recent annotated tag reachable from the last commit:
  
{{hc|<nowiki>pkgver() {
+
{{hc|<nowiki>
   cd local_repo
+
pkgver() {
   git describe --always | sed 's|-|.|g'
+
   cd "$pkgname"
 +
   git describe --long | sed 's/\([^-]*-g\)/r\1/;s/-/./g'
 
}</nowiki>|
 
}</nowiki>|
2.0.6
+
2.0.r6.ga17a017
 
}}
 
}}
  
If there are no annotated tags:
+
Using the most recent un-annotated tag reachable from the last commit:
  
{{hc|<nowiki>pkgver() {
+
{{hc|<nowiki>
   cd local_repo
+
pkgver() {
   echo $(git rev-list --count HEAD).$(git rev-parse --short HEAD)
+
   cd "$pkgname"
 +
   git describe --long --tags | sed 's/\([^-]*-g\)/r\1/;s/-/./g'
 
}</nowiki>|
 
}</nowiki>|
1142.a17a017
+
0.71.r115.gd95ee07
 +
}}
 +
 
 +
In case if the git tag does not contain dashes then one can use simpler sed expression {{ic|sed 's/-/.r/;s/-/./'}}.
 +
 
 +
If tag contains a prefix, like {{ic|v}} or project name then it should be cut off:
 +
 
 +
{{hc|<nowiki>
 +
pkgver() {
 +
  cd "$pkgname"
 +
  # cutting off 'foo-' prefix that presents in the git tag
 +
  git describe --long | sed 's/^foo-//;s/\([^-]*-g\)/r\1/;s/-/./g'
 +
}</nowiki>|
 +
6.1.r3.gd77e105
 +
}}
 +
 
 +
If there are no tags then use number of revisions since beginning of the history:
 +
 
 +
{{hc|<nowiki>
 +
pkgver() {
 +
  cd "$pkgname"
 +
  printf "r%s.%s" "$(git rev-list --count HEAD)" "$(git rev-parse --short HEAD)"
 +
}</nowiki>|
 +
r1142.a17a017
 +
}}
 +
 
 +
Version and only commit/revision number (SHA1 omitted; however, without a SHA1 quick referencing of an exact revision is lost if not mindful of versioning):
 +
 
 +
git describe --long | sed -r 's/-([0-9,a-g,A-G]{7}.*)//' | sed 's/-/./'
 +
 
 +
Both methods can also be combined, to support repositories that start without a tag but get tagged later on (uses a bashism):
 +
 
 +
{{hc|<nowiki>
 +
pkgver() {
 +
  cd "$pkgname"
 +
  ( set -o pipefail
 +
    git describe --long 2>/dev/null | sed 's/\([^-]*-g\)/r\1/;s/-/./g' ||
 +
    printf "r%s.%s" "$(git rev-list --count HEAD)" "$(git rev-parse --short HEAD)"
 +
  )
 +
}</nowiki>|
 +
0.9.9.r27.g2b039da  # if tags exist
 +
r1581.2b039da      # else fallback
 
}}
 
}}
  
 
==== Subversion ====
 
==== Subversion ====
{{hc|<nowiki>pkgver() {
+
 
   cd "$SRCDEST/local_repo"
+
{{hc|<nowiki>
   svnversion | tr -d [A-z]
+
pkgver() {
 +
   cd "$pkgname"
 +
   local ver="$(svnversion)"
 +
  printf "r%s" "${ver//[[:alpha:]]}"
 
}</nowiki>|
 
}</nowiki>|
8546
+
r8546
 
}}
 
}}
  
{{Note|The copy in {{ic|$srcdir}} is made using {{ic|svn export}} which does not create working copies. Any {{ic|svn}} related command has to be used in the local repo in {{ic|$SRCDEST}}.}}
+
{{Note|If the project has releases you should use them instead of the {{ic|0.}}.}}
  
 
==== Mercurial ====
 
==== Mercurial ====
{{hc|<nowiki>pkgver() {
+
 
   cd local_repo
+
{{hc|<nowiki>
   echo $(hg identify -n).$(hg identify -i)
+
pkgver() {
 +
   cd "$pkgname"
 +
   printf "r%s.%s" "$(hg identify -n)" "$(hg identify -i)"
 
}</nowiki>|
 
}</nowiki>|
2813.75881cc5391e
+
r2813.75881cc5391e
 
}}
 
}}
  
 
==== Bazaar ====
 
==== Bazaar ====
{{hc|<nowiki>pkgver() {
+
 
   cd local_repo
+
{{hc|<nowiki>
   bzr revno
+
pkgver() {
 +
   cd "$pkgname"
 +
   printf "r%s" "$(bzr revno)"
 
}</nowiki>|
 
}</nowiki>|
830
+
r830
 
}}
 
}}
  
 
==== Fallback ====
 
==== Fallback ====
The current date can be used, in case no satisfactory {{ic|pkgver}} can be extracted from the repo:
 
  
{{hc|<nowiki>pkgver() {
+
In case no satisfactory {{ic|pkgver}} can be extracted from the repository, the current date can be used:
 +
 
 +
{{hc|<nowiki>
 +
pkgver() {
 
   date +%Y%m%d
 
   date +%Y%m%d
 
}</nowiki>|
 
}</nowiki>|
 
20130408
 
20130408
 
}}
 
}}
 +
 +
Although it does not identify source tree state uniquely, so avoid it if possible.
  
 
== Tips ==
 
== Tips ==
  
=== A sample Git PKGBUILD ===
+
=== Git Submodules ===
# Maintainer: Dave Reisner <d@falconindy.com>
+
Git submodules are a little tricky to do. The idea is to add the URLs of the submodules themselves directly to the sources array and then reference them during prepare(). This could look like this:
# Contributor: 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="https://github.com/falconindy/expac"
+
license=('MIT')
+
depends=('pacman')
+
makedepends=('git' 'perl')
+
conflicts=('expac')
+
provides=('expac')
+
# The git repo is detected by the 'git:' or 'git+' beginning. The branch
+
# 'pacman41' is then checked out upon cloning, expediating versioning:
+
#source=('git+https://github.com/falconindy/expac.git'
+
source=('git://github.com/falconindy/expac.git'
+
        'expac_icon.png')
+
# Because the sources are not static, skip Git checksum:
+
md5sums=('SKIP'
+
          '020c36e38466b68cbc7b3f93e2044b49')
+
+
pkgver() {
+
  cd $_gitname
+
  # Use the tag of the last commit
+
  git describe --always | sed 's|-|.|g'
+
}
+
+
build() {
+
  cd $_gitname
+
  make
+
}
+
+
package() {
+
  cd $_gitname
+
  make PREFIX=/usr DESTDIR="$pkgdir" install
+
  install -Dm644 "$srcdir/expac_icon.png" "$pkgdir/usr/share/pixmaps/expac.png"
+
}
+
 
+
=== Removing VCS leftovers ===
+
To make sure that there are no VCS leftovers use the following at the end of the {{ic|package()}} function (replacing {{ic|'''.git'''}} with {{ic|.svn}}, {{ic|.hg}}, etc.):
+
find "$pkgdir" -type d -name '''.git''' -exec rm -r '{}' +
+
 
+
=== SVN packages that try to get their revision number ===
+
If the build system for the program you are packaging calls {{ic|svnversion}} or {{ic|svn info}} to determine its revision number, you can add a {{ic|prepare()}} function similar to this one to make it work:
+
 
+
prepare() {
+
  cp -a "$SRCDEST/$_svnmod/.svn" "$srcdir/$_svnmod/"
+
}
+
 
+
== Troubleshooting ==
+
 
+
=== Bazaar limitation ===
+
Currently, only one type of bazaar URLs can be used in the source array, which format is specific to the host. For example, Launchpad URLs will need to start with {{ic|http://bazaar.launchpad.net/}}, e.g.:
+
source=('project_name::bzr+http://bazaar.launchpad.net/~project_team/project_path')
+
  
Also, lp: URLs are not supported at the moment. Failing to use the correct URL will prevent makepkg from updating the local repo. The correct URL for each host can be obtained by running:
+
{{bc|<nowiki>
$ bzr config parent_location
+
source=("git://somewhere.org/something/something.git"
inside the local repo.
+
        "git://somewhere.org/mysubmodule/mysubmodule.git")
  
{{Note|These issues will be fixed in pacman 4.1.1.}}
+
prepare() {
 +
  cd something
 +
  git submodule init
 +
  git config submodule.mysubmodule.url $srcdir/mysubmodule
 +
  git submodule update
 +
}
 +
</nowiki>}}

Latest revision as of 09:17, 5 March 2016

Package creation guidelines

CLRCrossEclipseFree PascalGNOMEGoHaskellJavaKDEKernelLispMinGWNode.jsNonfreeOCamlPerlPHPPythonRubyVCSWebWine

Version control systems can be used for retrieval of source code for both usual statically versioned packages and latest (trunk) version of a development branch. This article covers both cases.

Prototypes

Use only the PKGBUILD prototypes provided in the pacman package (PKGBUILD-split.proto, PKGBUILD-vcs.proto and PKGBUILD.proto in /usr/share/pacman). The prototypes files in the abs package and in the ABS git repository are significantly out of date and should not be used. See FS#34485.

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 is not.
  • 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.
  • Include the appropriate VCS tool in makedepends=() (cvs, subversion, git, ...).
  • Because the sources are not static, skip the checksum in md5sums=() by adding 'SKIP'.

VCS sources

Note: Pacman 4.1 supports the following VCS sources: bzr, git, hg and svn. See the fragment section of man PKGBUILD or PKGBUILD(5) for a list of supported VCS.

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 repository 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 repository is left untouched, thus invalidating the need for a -build directory.

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

source=('[folder::][vcs+]url[#fragment]')
  • folder (optional) is used to change the default repository name to something more relevant (e.g. than trunk) or to preserve the previous sources.
  • vcs+ is needed for URLs that do not reflect the VCS type, e.g. git+http://some_repo.
  • url is the URL to the distant or local repository.
  • #fragment (optional) is needed to pull a specific branch or commit. See man PKGBUILD for more information on the fragments available for each VCS.

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. To use pkgver(), you still need to declare the pkgver variable with the most recent value. makepkg will invoke function pkgver(), and update variable pkgver accordingly.

It is recommended to have following version format: RELEASE.rREVISION where REVISION is a monotonically increasing number that uniquely identifies the source tree (VCS revisions do this). If there are no public releases and no repository tags then zero could be used as a release number or you can drop RELEASE completely and use version number that looks like rREVISION. If there are public releases but repo has no tags then the developer should get the release version somehow e.g. by parsing the project files.

The revision number delimiter ("r" right before REVISION) is important. This delimiter allows to avoid problems in case if upstream decides to make its first release or uses versions with different number of components. E.g. if at revision "455" upstream decides to release version 0.1 then the revision delimiter preserves version monotonicity - 0.1.r456 > r454. Without the delimiter monotonicity fails - 0.1.456 < 454.

See PKGBUILD-vcs.proto for generic examples showing the intended output.

Git

Using the most recent annotated tag reachable from the last commit:

pkgver() {
  cd "$pkgname"
  git describe --long | sed 's/\([^-]*-g\)/r\1/;s/-/./g'
}
2.0.r6.ga17a017

Using the most recent un-annotated tag reachable from the last commit:

pkgver() {
  cd "$pkgname"
  git describe --long --tags | sed 's/\([^-]*-g\)/r\1/;s/-/./g'
}
0.71.r115.gd95ee07

In case if the git tag does not contain dashes then one can use simpler sed expression sed 's/-/.r/;s/-/./'.

If tag contains a prefix, like v or project name then it should be cut off:

pkgver() {
  cd "$pkgname"
  # cutting off 'foo-' prefix that presents in the git tag
  git describe --long | sed 's/^foo-//;s/\([^-]*-g\)/r\1/;s/-/./g'
}
6.1.r3.gd77e105

If there are no tags then use number of revisions since beginning of the history:

pkgver() {
  cd "$pkgname"
  printf "r%s.%s" "$(git rev-list --count HEAD)" "$(git rev-parse --short HEAD)"
}
r1142.a17a017

Version and only commit/revision number (SHA1 omitted; however, without a SHA1 quick referencing of an exact revision is lost if not mindful of versioning):

git describe --long | sed -r 's/-([0-9,a-g,A-G]{7}.*)//' | sed 's/-/./'

Both methods can also be combined, to support repositories that start without a tag but get tagged later on (uses a bashism):

pkgver() {
  cd "$pkgname"
  ( set -o pipefail
    git describe --long 2>/dev/null | sed 's/\([^-]*-g\)/r\1/;s/-/./g' ||
    printf "r%s.%s" "$(git rev-list --count HEAD)" "$(git rev-parse --short HEAD)"
  )
}
0.9.9.r27.g2b039da  # if tags exist
r1581.2b039da       # else fallback

Subversion

pkgver() {
  cd "$pkgname"
  local ver="$(svnversion)"
  printf "r%s" "${ver//[[:alpha:]]}"
}
r8546
Note: If the project has releases you should use them instead of the 0..

Mercurial

pkgver() {
  cd "$pkgname"
  printf "r%s.%s" "$(hg identify -n)" "$(hg identify -i)"
}
r2813.75881cc5391e

Bazaar

pkgver() {
  cd "$pkgname"
  printf "r%s" "$(bzr revno)"
}
r830

Fallback

In case no satisfactory pkgver can be extracted from the repository, the current date can be used:

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

Although it does not identify source tree state uniquely, so avoid it if possible.

Tips

Git Submodules

Git submodules are a little tricky to do. The idea is to add the URLs of the submodules themselves directly to the sources array and then reference them during prepare(). This could look like this:

source=("git://somewhere.org/something/something.git"
        "git://somewhere.org/mysubmodule/mysubmodule.git")

prepare() {
  cd something
  git submodule init
  git config submodule.mysubmodule.url $srcdir/mysubmodule
  git submodule update
}