Arch Build System

Dieser Artikel wurde als veraltet markiert, und sollte kontrolliert, und gegebenfalls korrigiert bzw. aktualisiert werden.

Achtung: Mit Wirkung vom 16.05.2017 existiert das Paket extra/abs nicht mehr. Die neue offizielle Alternative heißt asp. Bitte beachtet in diesem Zusammenhang die Manpage.

Das Arch Build System (ABS) wird genutzt um:

Neue Pakete für Software zu erstellen
Vorhande Pakete an die eigenen Bedürfnisse anzupassen

Das Arch Build System besteht aus einem Werkzeug zum Herunterladen der PKGBUILDS (offiziell asp, alternativ z.B. pbget), makepkg und pacman. Dieser Artikel versucht nun eine Übersicht über das Erstellen von Paketen unter Archlinux zu geben. Detailreichere Informationen finden sich in den jeweiligen Manpages.

Vorbereitung

Man benötigt ein Tool, um das oder die PKGBUILDS, an denen man interessiert ist, herunter zu laden. Dazu kann man das Paket asp installieren:

pacman -S asp

Dieses Paket wendet sich allerdings weniger an den gelegentlichen Paketersteller als an den Arch Linux Entwickler oder TU. Das erkennt man daran, dass die Pakete in einer Verzeichnisstruktur heruntergeladen werden, die der entspricht, die auf den offizellen Entwicklungsserver vorliegt. Ein Beispiel

asp checkout emacs

erzeugt ein Verzeichnis /var/tmp/emacs und darunter

$ ls -lR /var/tmp/emacs
/var/tmp/emacs:
nsgesamt 8
drwxr-xr-x 4 haawda users 4096  3. Sep 01:03 repos
drwxr-xr-x 2 haawda users 4096  3. Sep 01:03 trunk
/var/tmp/emacs/repos:
insgesamt 8
drwxr-xr-x 2 haawda users 4096  3. Sep 01:03 extra-i686
drwxr-xr-x 2 haawda users 4096  3. Sep 01:03 extra-x86_64
/var/tmp/emacs/repos/extra-i686:
insgesamt 4
-rw-r--r-- 1 haawda users 1546  3. Sep 01:03 PKGBUILD
/var/tmp/emacs/repos/extra-x86_64:
insgesamt 4
-rw-r--r-- 1 haawda users 1546  3. Sep 01:03 PKGBUILD
/var/tmp/emacs/trunk:
insgesamt 4
-rw-r--r-- 1 haawda users 1546  3. Sep 01:03 PKGBUILD

Das ist eine Struktur, mit der der gelegentliche Paketersteller vermutlich nicht arbeiten will. Hier bietet sich an, auf ein Tool wie pbget zurückzugreifen. pbget ist dem Ursprung nach eher ein AUR-Helper, kann aber auch offizielle PKGBUILDS herunterladen.

pbget emacs

z.B. erzeugt im aktuellen Verzeichnis ein Unterverzeichnis mit den Dateien, die man zur Erzeugung des offiziellen emacs-Paketes braucht. Das ist erheblich einfacher zu durchschauen.

Alle sonstigen Pakete, die zur Erstellung von Paketen notwendig sind, befinden sich in der Gruppe base-devel:

pacman -S base-devel

Das Paket

Ein Paket ist eine Datei, die der Namenskonvention foo.pkg.tar.zst entspricht.

Die Paketendung deutet es schon an: Es handelt sich um ein mit zstd komprimiertes tar-Archiv, das neben den eigentlichen Daten, die durch das Paket verwaltet werden sollen, noch folgendes enthält:

Die zu installierenden Dateien

.PKGINFO : enthält alle Metadaten, die pacman für den Umgang mit Paketen, Abhängigkeiten etc. benötigt.

.BUILDINFO : enthält weitere Metadaten über die Parameter, die beim Bau des Paketes aktiv waren, sowie eine Lister der zum Zeitpunkt des Bauens installierten Pakete.

.INSTALL : enthält Befehle, die nach dem Installieren/Aktualisieren/Deinstallieren ausgeführt werden. (Nur vorhanden, wenn es in PKGBUILD definiert wurde)

Das PKGBUILD

Ein PKGBUILD enthält die Bauanweisungen und Metadaten über ein Paket, das von pacman installierbar sein soll. Es stellt die Grundlage für Pakete in Archlinux dar. Ein PKGBUILD ist eine einfache Textdatei, die Bash-Code (die PKGBUILDs einfach aus der bash heraus aufzurufen schlägt aber fehl. Sie werden von makepkg eingebunden.) enthält und beispielsweise so aussehen kann:

# $Id: PKGBUILD,v 1.12 2003/11/06 08:26:13 dorphell Exp $
# Maintainer: judd <jvinet@zeroflux.org>
# Contributor: Judd Vinet <jvinet@zeroflux.org>
pkgname=foo
pkgver=0.99 # note: if the pkgver had been '0.99-10' then use an underscore. like '0.99_10'
pkgrel=1
pkgdesc="short description of foo"
arch=(i686 x86_64)
url="http://www.foo.org"
license=('GPL')
groups=
provides=
depends=('qt' 'python')
makedepends=('guile')
conflicts=('yafoo')
replaces=('mffoo')
backup=('etc/foo/foo.conf')
install='foo.install'
source=(http://www.foo.org/download/$pkgname-$pkgver.tar.gz)
md5sums=('2c0cca3ef6330a187c6ef4fe41eca')

build() {
  cd $srcdir/$pkgname-$pkgver
  ./configure --prefix=/usr
  make
}
package() {
  cd $srcdir/$pkgname-$pkgver
  make DESTDIR=$pkgdir install
}

Erklärung:

# text : Kommentare
# $Id: PKGBUILD,v ... : Das SVN-Tag für dieses Paket (automatisch vom Archlinux-SVN System erstellt). Dies sollte bei Paketen, die für das AUR gedacht sind, stets weggelassen werden.
# Maintainer : Der Betreuer für dieses Paket
# Contributor : Jemand, der zu dem PKGBUILD darüber hinaus etwas beigetragen hat. Das kann zum Beispiel ein vorheriger Betreuer des Pakets sein.
pkgbase : Optional, bei Nichtangabe wird automatisch der erste Wert im Array $pkgname verwendet. Kommt nur bei Split packages zum Tragen.
pkgname : Der Paketname, kann alternativ auch ein Array sein (Split Packages)
pkgver : Die Paketversion
pkgrel : Die Releasenummer des Arch Paketes. Wird geändert, wenn das PKGBUILD verändert wurde oder (bei Paketen aus den Repos) das Paket neu gebaut werden musste.
pkgdesc : Eine Kurzbeschreibung des Paketes, zu sehen in der Paket Datenbank
arch : Die Architekturen, auf denen das Paket kompiliert und getestet wurde, oder 'any' bei plattformunabhängigen Paketen.
url : Die Homepage des Programmes
license : Die Lizenz, unter der das Programm steht
groups : Wird genutzt um Pakete zu Gruppen zusammen zu fassen. Wenn du z.B. KDE installieren willst, werden alle Pakete installiert, die zur Gruppe 'kde' gehören Liste der Gruppen
provides : Wird genutzt, wenn das Paket ein anderes Paket bereitstellt.
depends : Liste der Abhängigkeiten um das Programm auszuführen.
makedepends : Liste der Abhängigkeiten um das Programm zu kompilieren. Pakete, die schon unter depends aufgeführt wurden, sind hier nicht noch einmal aufzuführen.
conflicts : Pakete, die nicht zusammen mit diesem Programm installiert sein können. In unserem Fall steht foo in Konflikt zu yafoo.
replaces : Das neue Paket ersetzt das alte. In unserem Fall wird mffoo nicht mehr unterstützt und wird durch foo ersetzt.
backup : Dateien, die gesichert werden (als .pacsave), wenn das Programm deinstalliert wird.
install : Spezifiziert ein Installationsskript, das im Paket enthalten ist. (Muss sich mit PKGBUILD im selben Verzeichnis befinden)
source : Die Bezugsquelle(n) des Quelltextes. Kann sowohl ein lokales Paket, als auch ein remote "http" oder "ftp" Paket sein. Der Dateiname wird aus pkgname und pkgver erstellt, damit der Pfad nicht bei jeder neuen Version angepasst werden muss.
md5sums : MD5 Summen der Quelltexte um beschädigte Dateien auszuschließen.
build() : Alle Schritte, die nötig sind um den Quelltext zu übersetzen (optional). Die Schritte müssen mit normalen Benutzerrechte ausgeführt werden können.
package(): Alle Schritte, die nötig sind, um die nötigen Dateien ins eigentliche Paket zu übertragen.

Die Build-Funktion und die Package-Funktion

Neben der Build- und der Package-Funktion kann es auch noch eine Prepare- und eine Pkgver-Funktion geben. Die prepare-Funktion dient dazu, Anpassungen am eigentlichen Quelltext vorzunehmen, und sollte nur in Ausnahmefällen verwendet werden (ein Beispiel siehe unten). Die pkgver-Funktion dient zur automatischen Generierung einer Paketversion und kommt hauptsächlich zum Tragen, wenn die Quellcodes über ein VCS bezogen werden. Reihenfolge der Ausführung:

prepare(){}
pkgver(){}
build(){}
package(){}

In der build-Funktion werden die Anweisungen ausgeführt, die nötig sind, um das Paket zu kompilieren. Sie kann entfallen (Binary-Blobs, Java-Jar-Files, Skripte).

In der package-Funktion werden die zu installierenden Dateien und Verzeichnisse so abgelegt, dass makepkg daraus einen Tarball - das Paket - erstellen kann, der dann von pacman installiert werden kann. In einem ersten Schritt geschieht die durch Anlegen eine Verzeichnisbaums namens 'pkg' (hirauf zeigt die Bash-Variable pkgdir). Es muss mindestens eine, kann aber auch mehrere Package-Funktionen geben. Bei mehreren package-Funktionen spricht man von Package Splitting.

Viele Pakete (nämlich die, die auf die Verwendung der GNU-Autotools hin ausgelegt sind) können über den Dreisatz erstellt werden:

./configure --prefix=/usr
make
make install

./configure überprüft zunächst, ob alle Voraussetzungen für das zu kompilierende Programm erfüllt sind. Über dieses Script lässt sich auch konfigurieren, wie und mit welchen Funktionen ein Programm kompiliert wird. ./configure --help zeigt meistens eine Übersicht über die Optionen, die verfügbar sind. make kompiliert schließlich das Paket und make install installiert die Dateien.

Du solltest immer die INSTALL oder die README Datei des jeweiligen Pakets lesen, um zu erfahren, wie es erstellt und installiert werden sollte, denn nicht alle Pakete nutzen diesen Dreisatz! Bei neueren Build-Systemen (cmake, meson/ninja) ist es prinzipiell nicht anders, aber die Befehle des Dreisatz lauten anders.

Eine 'Standard', autotools-basierte build-Funktion sieht so aus:

build() {
 cd $pkgname-$pkgver
 ./configure --prefix=/usr
 make
}

Erklärung:

In das Verzeichnis der von makepkg entpackten Quelltexte wechseln (hier treten in der Praxis oft schon Probleme auf; besser, man schaut nach ob das Verzeichnis wirklich so heißt):

cd $pkgname-$pkgver # bei neueren makekpkg-Versionen muss nicht mehr explizit nach $srcdir gewechselt werden, aber es ist nich falsch, hier $srcdir/$pkgname-$pkgver zu verwenden.

Konfigurieren des Paketes mit dem Installationsverzeichnis /usr und unter Umständen weiteren Optionen:

./configure --prefix=/usr --option1 --option2

Da die meisten Programme davon ausgehen, dass nach /usr/local installiert werden soll, wir unter Arch Linux aber nach /usr installieren wollen, ist es wichtig, das Prefix zu setzen.

kompilieren:

make

Eine 'Standard' package-Funktion sieht so aus:

installieren:

make DESTDIR=$pkgdir install

Dabei wird das Programm nicht in /usr sondern in $pkgdir/usr installiert, so dass erst einmal makepkg und indirekt auch pacman Kontrolle über die Dateien hat. Ob DESTDIR verwendet wird, hängt vom jeweiligen Programm bzw. dessen Makefile ab. Manchmal muss z.B. auch PREFIX verwendet und entsprechend umgebogen werden, und wenn Upstream es gar nicht auf die Reihe bekommt, muss auch ein manuelles Kopieren gewählt werden.

make PREFIX=$pkgdir/usr install

Installationsdateien

Installationsdateien stellen die Möglichkeit bereit, Anweisungen vor oder nach der eigentlichen Installation auszuführen. Seitdem pacman Hooks verwenden kann, sind sie in einer Vielzahl von Fällen nicht mehr nötig und sollten dann auch vermieden werden. Dazu müssen sie im PKGBUILD angegeben werden, indem man die Variable install setzt. Unser Beispiel gibt 'foo.install' als Installationsdatei an. Es könnte z.B. folgendes enthalten:

post_install() {
/bin/true
}

post_upgrade() {
/bin/true
}

pre_remove() {
/bin/true
}

Erklärungen:

post_install: Wird nach der Installation ausgeführt. Es wird ein Argument übergeben:
- Die Paketversion
post_upgrade: Wird ausgeführt, nachdem alle Dateien aktualisiert wurden. Es werden zwei Argumente übergeben:
- Die neue Paketversion
- Die alte Paketversion
pre_remove: Wird ausgeführt, bevor Dateien gelöscht werden (beendet z.B. daemonen) und übergibt ein Argument:
- Die Paketversion

Der Verzeichnisbaum der offiziellen Pakete

Bei Arch Linux werden die PKGBUILDs, anhand derer die Pakete in den offiziellen Repositories gebaut sind, mit Subversion verwaltet. Darüber ist noch eine git-Infrastruktur mittels svntogit etabliert.

Will man die Gesamtheit aller Pakete auf den lokalen Rechner herunterladen oder aktualisieren, so kann dafür also subversion oder git verwendet werden.

Wir bitten jedoch darum, davon abzusehen. Die Repos sind groß, und die Bandbreite zu den Arch Linux Servern ist begrenzt. Außerdem wird auch viel Platz auf dem lokalen Dateisystem benötigt.

Erstellung von Paketen

Achtung: Um Schäden am System zu vermeiden, sollten Pakete nie als root erstellt werden!

Pakete werden mit makepkg erstellt. Dazu muss in das Verzeichnis gewechselt werden, in dem sich das Paket befindet und hier makepkg ausgeführt werden. Verzeichnisse aus dem ABS-Verzeichnisbaum sollten zuvor woandershin, zum Beispiel nach /var/abs/local oder nach ~/paketierung kopiert werden und nicht zur Erstellung des Pakets benutzt werden.

~/paketierung/foo/PKGBUILD (und ggf. noch weitere Dateien wie install-files, desktop-files, Patches u.v.m.

Sind nicht alle Abhängigkeiten zum Bau vorhanden, listet makepkg diese auf. makepkg -s würde versuchen, sie zu installieren. Das funktioniert aber nur, wenn sie in einem Repo vorhanden sind, auf das die Datei pacman.conf referenziert.

cd ~/paketierung/foo
makepkg

Jetzt entstehen ein Verzeichnis namens src, und eines namens pkg. In ersterem findet der Paketbau statt in letzerem landen die Dateien, die ins fertige Paket sollen. Im PKGBUILD kann mit $srcdir bzw. $pkgdir darauf zugegriffen werden.

~/paketierung/foo/PKGBUILD
                  src
                  pkg

Das erstellte Paket (oder je nach Konfiguration der Variablen PKGDEST in der makepkg.conf ein Link darauf) befindet sich jetzt im selben Verzeichnis und kann mit pacman installiert werden:

pacman -U foo-0.99-x86_64.pkg.tar.zst

Konfiguration

makepkg.conf

Achtung: Viele Änderungen in makepkg.conf können Probleme und Fehler in den Paketen nach sich ziehen und sollten daher nur von erfahreneren Nutzern durchgeführt werden. Dies betrifft nicht Änderungen wie den PACKAGER und seine E-Mail-Adresse.

In der Datei /etc/makepkg.conf werden die Eigenschaften von makepkg festgelegt. Dabei lassen sich die Standardeinstellungen der Programme verändern, die makepkg verwendet, um Pakete zu erstellen. Zu nennen sind dabei die Umgebungsvariablen MAKEFLAGS, CFLAGS und CXXFLAGS, die gcc und make beeinflussen.

Hinzufügen von Patches

Hier wird beschrieben wie man einen Patch den man selbst erstellt oder heruntergeladen hat, in die prepare () Funktion einer PKGBUILD Datei einpflegt.

Als erstes fügt man einen Eintrag für den Patch in die source Zeile ein. Dieser Eintrag muss durch ein Leerzeichen von dem URL zur Originalquelle getrennt sein. Ist der Patch im Internet verfügbar, trägt man den vollständigen URL zum Patch ein, der Patch wird dann später beim eigentlichen Kompilieren des Paketes automatisch heruntergeladen und im src Verzeichnis abgelegt. Hat man den Patch selbst erstellt, oder bereits vorher heruntergeladen, legt man ihn im selben Verzeichnis wie die PKGBUILD Datei ab. In diesem Fall trägt man lediglich den Dateinamen des Patches in die source Zeile ein. Der Patch wird dann automatisch in das source Verzeichnis kopiert. Sollte man die PKGBUILD Datei weitergeben wollen, so muss man sie mit der Patchdatei zusammen weitergeben. Anschließend fügt man einen Eintrag zur md5sums bzw. sha1sums Zeile hinzu. Die Prüfsummen erstellt man mittels makepkg -g. Nun erstellt man die prepare() Funktion. Um das Patchen zu automatisieren trägt man die Anweisung in das zu patchende Verzeichnis zu wechseln ein; z.B.

cd $srcdir/$pkgname-$pkgver

oder ähnlich. $pkname-$pkgver ist oftmals, aber nicht immer, der Name des beim Entpacken einer heruntergeladenen Quelldatei erstellten Verzeichnisses. Abschließend muss man noch dafür sorgen, dass der Patch aus dem angegebenen Verzeichnis heraus appliziert werden kann. Dies geschieht, indem man

patch -p1 -i $srcdir/pkgname.patch

in die prepare() Funktion einträgt. Für pkgname.patch setzt man hier den zuvor in die source Zeile eingetragenen Dateinamen des Patches ein. Hier ein zur Veranschaulichung ein Beispiel für eine prepare Funktion mit Patchfunktion:

prepare() {
cd "${srcdir}/${pkgname}-${pkgver}"
sed 's/file_handle/file_handle_rofl/g' -i istream.*
patch -p1 -i ../https-segfault.patch 
patch -p1 -1 ../w3m-bdwgc72.diff
}

Das Paket kann nun in gewohnter Weise gebaut werden.

Siehe auch

Weblinks

Dieser Artikel (oder Teile davon) steht unter GNU FDL (GNU Freie Dokumentationslizenz) und ist eine Übersetzung aus dem ArchLinux.org Wiki. Am Original-Artikel kann jeder Korrekturen und Ergänzungen vornehmen. Im ArchLinux.org Wiki ist eine Liste der Autoren verfügbar.