Difference between revisions of "VCS package guidelines"

From ArchWiki
Jump to: navigation, search
m (Bot: Removing from Category:Guidelines (English))
(Guidelines: Add update guideline)
Line 21: Line 21:
  
 
* Properly suffix {{Codeline|pkgname}} with {{Codeline|-cvs}}, {{Codeline|-svn}}, {{Codeline|-hg}}, {{Codeline|-darcs}}, {{Codeline|-bzr}} or {{Codeline|-git}}. 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.
 
* Properly suffix {{Codeline|pkgname}} with {{Codeline|-cvs}}, {{Codeline|-svn}}, {{Codeline|-hg}}, {{Codeline|-darcs}}, {{Codeline|-bzr}} or {{Codeline|-git}}. 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 {{Codeline|pkgrel}} is mandatory. If both the revision number and the resulting binary remain the same, {{Codeline|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 {{Codeline|pkgver}} in the PKGBUILD.  Look at {{Codeline|--holdver}} in [http://www.archlinux.org/pacman/makepkg.8.html man makepkg] if you want otherwise.  {{Codeline|--holdver}} only works for cvs and svn, which allow checkout of older revisions.
 
* When [[makepkg]] is run, by default it will check for newer revisions and then update the {{Codeline|pkgver}} in the PKGBUILD.  Look at {{Codeline|--holdver}} in [http://www.archlinux.org/pacman/makepkg.8.html man makepkg] if you want otherwise.  {{Codeline|--holdver}} only works for cvs and svn, which allow checkout of older revisions.
Line 31: Line 33:
  
 
* When using/defining the cvsroot, use {{Codeline|anonymous:@}} rather than {{Codeline|anonymous@}} to avoid a password prompt and having to enter a blank password ''OR'' use {{Codeline|anonymous:password@}} if a password is required.
 
* When using/defining the cvsroot, use {{Codeline|anonymous:@}} rather than {{Codeline|anonymous@}} to avoid a password prompt and having to enter a blank password ''OR'' use {{Codeline|anonymous:password@}} if a password is required.
 
* Though it is often unnecessary to use the {{Codeline|pkgrel}} field when building CVS/SVN/GIT packages (changes to the package are usually often and will be reflected in the {{Codeline|pkgver}}), makepkg will require it.
 
  
 
* Don't forget to include the appropriate VCS tool (cvs, subversion, git, ...) in {{Codeline|1=makedepends=...}}.
 
* Don't forget to include the appropriate VCS tool (cvs, subversion, git, ...) in {{Codeline|1=makedepends=...}}.

Revision as of 16:57, 2 July 2011

This template has only maintenance purposes. For linking to local translations please use interlanguage links, see Help:i18n#Interlanguage links.


Local languages: Català – Dansk – English – Español – Esperanto – Hrvatski – Indonesia – Italiano – Lietuviškai – Magyar – Nederlands – Norsk Bokmål – Polski – Português – Slovenský – Česky – Ελληνικά – Български – Русский – Српски – Українська – עברית – العربية – ไทย – 日本語 – 正體中文 – 简体中文 – 한국어


External languages (all articles in these languages should be moved to the external wiki): Deutsch – Français – Română – Suomi – Svenska – Tiếng Việt – Türkçe – فارسی

Summary help replacing me
Creating PKGBUILDs for software managed with version control systems.
Related
Arch Build System
Arch User Repository
Creating Packages
makepkg
pacman
PKGBUILD

Guidelines for creating PKGBUILDs for software managed with version control systems.

Prototypes

The Template:Package Official package provides prototypes for cvs, svn, git, mercurial, and darcs PKGBUILDs. When abs is installed, you can find them in Template:Filename.

Guidelines

  • 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 Template:Codeline is mandatory. If both the revision number and the resulting binary remain the same, Template:Codeline 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.
  • Check for package conflicts. For example fluxbox-svn will conflict with fluxbox. In this case, you need to use Template:Codeline.
  • You should AVOID using Template:Codeline as it generally causes unnecessary problems.
  • Don't forget to include the appropriate VCS tool (cvs, subversion, git, ...) in Template:Codeline.
  • 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 Template:Filename from Template:Filename you can use:
mkdir src/$_cvsmod-build

cd src/$_cvsmod-build
../$_cvsmod/configure

or:

cp -r src/$_cvsmod src/$_cvsmod-build
cd src/$_cvsmod-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 Template:Codeline anyway when building the package (unless Template:Codeline is used).

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 Template:Codeline 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