Difference between revisions of "VCS package guidelines (简体中文)"
(→Example SVN PKGBUILD) |
m (update category.) |
||
(26 intermediate revisions by 14 users not shown) | |||
Line 1: | Line 1: | ||
− | + | [[Category:Package development (简体中文)]] | |
− | + | [[en:VCS PKGBUILD Guidelines]] | |
− | + | [[it:VCS PKGBUILD Guidelines]] | |
− | {{ | + | [[zh-TW:VCS PKGBUILD Guidelines]] |
− | {{ | + | {{Package Guidelines}} |
+ | {{Translateme (简体中文)}} | ||
+ | [[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. | ||
− | + | == 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]. | |
− | == | + | == Guidelines == |
− | * | + | * 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. | |
− | |||
− | ' | ||
− | |||
− | |||
− | * | + | * {{Ic|--holdver}} can be used to prevent [[makepkg]] from updating the {{ic|pkgver}} (see: [https://www.archlinux.org/pacman/makepkg.8.html makepkg(8)]) |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | * Include what the package conflicts with and provides (e.g. for {{AUR|fluxbox-git}}: {{Ic|1=conflicts=('fluxbox')}} and {{Ic|1=provides=('fluxbox')}}). | |
− | the | ||
− | |||
− | == | + | * {{Ic|1=replaces=()}} generally causes unnecessary problems and should be avoided. |
− | + | * 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. | |
− | + | * Include the appropriate VCS tool in {{Ic|1=makedepends}} ({{pkg|cvs}}, {{pkg|subversion}}, {{pkg|git}}, ...). | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | === 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.}} | |
− | + | 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 {{ic|1=source=()}} array is: | |
− | + | 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|vcs+}} is needed for URLs that do not reflect the VCS type, e.g. {{ic|git+http://some_repo}}. | |
+ | * {{ic|url}} is the URL to the distant or local repo | ||
+ | * {{ic|#fragment}} (optional) is needed to pull a specific branch or commit | ||
− | + | An example Git source array: | |
− | + | source=('project_name::git+http://project_url#branch=project_branch') | |
− | |||
− | + | === 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 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)" | |
− | + | } | |
− | pkgver | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | 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 |tr -d [A-z] | ||
+ | } | ||
− | + | {{Note|The copy inside {{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, hence {{ic|$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 {{ic|pkgver}} can be extracted from the repo: | |
− | |||
− | |||
− | + | pkgver() { | |
− | } | + | date +"%Y%m%d" |
− | + | } | |
− | == | + | == Tips == |
− | < | + | === A sample Git PKGBUILD for pacman 4.1 === |
− | pkgname= | + | # Maintainer: Dave Reisner <d@falconindy.com> |
− | pkgver= | + | # Contributor: William Giokas (KaiSforza) <1007380@gmail.com> |
− | pkgrel=1 | + | |
− | pkgdesc=" | + | pkgname=expac-git |
− | url=" | + | _gitname=expac |
− | license= | + | pkgver=0.0.0 |
− | depends=(' | + | 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') | |
− | + | # 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+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 "$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 | ||
+ | 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, bazaar URLs only work in the form of {{ic|http://bazaar.launchpad.net/}}, e.g.: | |
− | + | source=('project_name::bzr+http://bazaar.launchpad.net/~project_team/project_path') | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | Using any other {{ic|http://}}, {{ic|https://}} or {{ic|ssh://}} URL (including {{ic|lp:project_name}}) will prevent makepkg from updating the local repo. | |
− | } | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | The correct URL can be obtained with: | |
− | + | $ bzr config parent_location | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | : | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− |
Revision as of 12:59, 15 May 2013
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.
Contents
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 thepkgver
isn't.
-
--holdver
can be used to prevent makepkg from updating thepkgver
(see: makepkg(8))
- Include what the package conflicts with and provides (e.g. for fluxbox-gitAUR:
conflicts=('fluxbox')
andprovides=('fluxbox')
).
-
replaces=()
generally causes unnecessary problems and should be avoided.
- When using the cvsroot, use
anonymous:@
rather thananonymous@
to avoid having to enter a blank password oranonymous:password@
, if one is required.
- Include the appropriate VCS tool in
makedepends
(cvs, subversion, git, ...).
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 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=('[folder::][vcs+]url[#fragment]')
-
folder
(optional) is used to change the default repo name to something more relevant (e.g. thantrunk
) 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 repo -
#fragment
(optional) is needed to pull a specific branch or commit
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 |tr -d [A-z] }
$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
A sample Git PKGBUILD for pacman 4.1
# Maintainer: Dave Reisner <d@falconindy.com> # 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') # 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+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 "$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 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 package()
function (replacing .git
with .svn
, .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 svnversion
or svn info
to determine its revision number, you can add a prepare()
function similar to this one to make it work:
prepare() { cp -a "$SRCDEST/$_svnmod/.svn" "$srcdir/$_svnmod/" }
Troubleshooting
Bazaar limitation
Currently, bazaar URLs only work in the form of http://bazaar.launchpad.net/
, e.g.:
source=('project_name::bzr+http://bazaar.launchpad.net/~project_team/project_path')
Using any other http://
, https://
or ssh://
URL (including lp:project_name
) will prevent makepkg from updating the local repo.
The correct URL can be obtained with:
$ bzr config parent_location