Kapitel 2. Erste Schritte

Bitte beachten Sie, dass das Zeichen, das Paket und Version trennt, von - (Bindestrich) im Tarball-Namen zu _ (Unterstrich) im Debian-Paketdateinamen geändert wurde.

Im obigen Dateinamen wird der Paket-Teil durch den Paketnamen, der Version-Teil durch die Version der Originalautoren, der Revision-Teil durch die Debian-Revision und der arch-Teil durch die Paketarchitektur, wie im »Debian Policy Manual« festgelegt, ersetzt. ^[5]

Jeder Schritt dieser Übersicht wird in späteren Abschnitten mit detaillierten Beispielen erklärt.

Wenn es das Paket schon gibt, na, dann installieren Sie es! :-) Falls es verwaist (»orphaned«) wurde (wenn als Betreuer »Debian QA Group« eingetragen ist), dann können Sie es übernehmen, wenn es noch verfügbar ist. Sie können auch ein Paket adoptieren, dessen Betreuer einen »Request for Adoption« (RFA) geschrieben hat. ^[6]

Es gibt mehrere Ressourcen zur Paketeigentümerschaft:

Als wichtige Randbemerkung sei darauf hingewiesen, dass Debian bereits für fast alle Arten von Programmen Pakete enthält und die Anzahl der Pakete im Debian-Archiv wesentlich größer ist als die der Mitwirkenden mit Berechtigung zum Hochladen. Daher werden Beiträge zu Paketen, die bereits im Archiv enthalten sind, von anderen Entwicklern wesentlich mehr gewürdigt (und haben bessere Chancen, gesponsert zu werden) ^[7]. Sie können auf verschiedene Arten beitragen:

Wenn Sie ein Paket übernehmen möchten, laden Sie sich das Quell-Paket herunter (z. B. mit »apt-get source Paketname«) und nehmen Sie es unter die Lupe. Leider enthält dieses Dokument keine umfassende Anleitung zum Übernehmen von Paketen. Der Vorteil ist, dass schon jemand das Paket für Sie vorbereitet hat und Sie keine Schwierigkeiten haben sollten, herauszufinden, wie das Paket funktioniert. Doch lesen Sie weiter, denn viele der folgenden Ratschläge werden auch für Sie nützlich sein.

Falls das Paket neu ist und Sie es gern in Debian integrieren möchten, gehen Sie wie folgt vor:

Natürlich ist der zuletzt aufgeführt Punkte eher eine Sicherheitsmaßnahme und sollte Sie vor tobenden Benutzern schützen, falls Ihr setuid-Daemon irgendetwas Schlimmes anstellt … wenn Sie mehr Erfahrungen im Erstellen von Paketen gesammelt haben, können Sie auch solche Software paketieren.

Als neuer Betreuer wird Ihnen empfohlen, Erfahrung im Paketieren einfacher Pakete zu sammeln und Ihnen abgeraten, komplizierte Pakete zu erstellen.

Paketieren von hochkomplexen Paketen ist nicht zu schwer, erfordert aber ein bisschen mehr Wissen. Sie sollten spezielle Hilfestellungen für jede komplexe Funktionalität erbitten. Beispielsweise haben einige Sprachen ihre eigenen Unter-Richtliniendokumente:

Es gibt einen alten lateinischen Spruch: fabricando fit faber (Übung macht den Meister). Es wird nachdrücklich empfohlen, zu üben und mit allen Schritten der Debian-Paketierung mit einfachen Paketen zu spielen, während diese Anleitung gelesen wird. Ein trivialer Tarball der Originalautoren ist hello-sh-1.0.tar.gz, der einen guten Startpunkt darstellt. Er wird wie folgt erstellt:^[8]

$ mkdir -p hello-sh/hello-sh-1.0; cd hello-sh/hello-sh-1.0
$ cat > hello <<EOF
#!/bin/sh
# (C) 2011 Foo Bar, GPL2+
echo "Hello!"
EOF
$ chmod 755 hello
$ cd ..
$ tar -cvzf hello-sh-1.0.tar.gz hello-sh-1.0

Kommt der Quellcode in einem anderen Archivtyp daher (beispielsweise wenn der Dateiname auf .Z oder .zip endet ^[9]), sollten Sie ihn auch mit den geeigneten Werkzeugen entpacken und neu packen.

Falls die Quellen Ihres Programms Inhalte enthalten, die nicht den DFSG genügen, sollten Sie sie auch entpacken, um solche Inhalte zu entfernen, und mit einer geänderten Version der Originalautoren, die dfsg enhält, neu packen.

Als Beispiel verwende ich hier ein Programm namens gentoo, einen GTK+-Dateimanager. ^[10]

Erstellen Sie ein Unterverzeichnis in Ihrem Home-Verzeichnis namens debian oder deb oder irgendetwas, das Sie passend finden (beispielsweise wäre in diesem Fall einfach ~/gentoo völlig in Ordnung). Kopieren Sie das heruntergeladene Archiv dorthin und entpacken Sie es (mit »tar xzf gentoo-0.9.12.tar.gz«). Vergewissern Sie sich, dass es keine Warnmeldungen beim Entpacken gab, nicht mal so genannte irrelevante, da die Entpackwerkzeuge anderer Leute diese Anomalien ignorieren oder auch nicht ignorieren könnten und sie daher beim Entpacken Probleme bekommen könnten. Ihre Shell-Befehlszeile könnte dann wie folgt aussehen:

$ mkdir ~/gentoo ; cd ~/gentoo
$ wget http://www.example.org/gentoo-0.9.12.tar.gz
$ tar xvzf gentoo-0.9.12.tar.gz
$ ls -F
gentoo-0.9.12/
gentoo-0.9.12.tar.gz

Jetzt haben Sie ein neues Unterverzeichnis namens gentoo-0.9.12. Wechseln Sie dorthin und lesen Sie die mitgelieferte Dokumentation aufmerksam durch. Meistens gibt es Dateien mit den Namen README*, INSTALL*, *.lsm oder *.html. Sie müssen eine Anleitung finden, wie man das Programm kompiliert und installiert (meistens wird von einer Installation in das Verzeichnis /usr/local/bin ausgegangen, aber das werden Sie nicht machen. Mehr dazu später in Abschnitt 3.3, „Installation von Dateien in ihr Zielverzeichnis“).

Sie sollten das Paketieren mit einem komplett aufgeräumten (»pristine«, makellosen) Quellcode-Verzeichnis anfangen oder die Quellen einfach frisch entpacken.

Einfache Programme enthalten normalerweise eine Makefile-Datei und können rein durch den Aufruf von »make« kompiliert werden. ^[11] Einige von ihnen unterstützen »make check«, wodurch die mitgelieferten Selbsttests gestartet werden. Die Installation in das Zielverzeichnis wird üblicherweise mittels »make install« durchgeführt.

Versuchen Sie nun, das Programm zu kompilieren und auszuführen. Stellen Sie sicher, dass es einwandfrei funktioniert und nichts anderes während der Installation oder der Ausführung beschädigt.

Meistens können Sie außerdem »make clean« (oder besser »make distclean«) ausführen, um im Build-Verzeichnis aufzuräumen. Manchmal gibt es sogar ein »make uninstall«, womit alle installierten Dateien gelöscht werden können.

Viele freie Software-Programme sind in den Sprachen C oder C++ geschrieben. Die meisten von ihnen verwenden Autotools oder CMake, um auf verschiedene Plattformen portierbar zu sein. Diese Bauwerkzeuge müssen zuerst benutzt werden, um das Makefile und andere benötigte Quelldateien zu erzeugen. Anschließend werden solche Programme mit dem üblichen »make; make install« gebaut.

Autotools ist das GNU-Buildsystem, das aus Autoconf, Automake, Libtool und gettext besteht. Sie erkennen solche Quellen an den Dateien configure.ac, Makefile.am und Makefile.in. ^[12]

Der erste Schritt im Arbeitsablauf der Autotools ist üblicherweise, dass der ursprüngliche Autor »autoreconf -i -f« im Quellenverzeichnis aufruft und die Quellen dann mit den erzeugten Dateien verteilt.

configure.ac-----+-> autoreconf -+-> configure
Makefile.am -----+        |      +-> Makefile.in
src/Makefile.am -+        |      +-> src/Makefile.in
                          |      +-> config.h.in
                      automake
                      aclocal
                      aclocal.m4
                      autoheader

Das Bearbeiten der Dateien configure.ac und Makefile.am erfordert etwas Wissen über autoconf und automake. Siehe »info autoconf« und »info automake«.

Der zweite Schritt im Arbeitsablauf der Autotools ist üblicherweise, dass der Benutzer diese verteilten Quellen erhält und »./configure && make« in den Quellen aufruft, um das Programm zu einem ausführbaren Binärdatei-Befehl zu kompilieren.

Makefile.in -----+                +-> Makefile -----+-> make -> binary
src/Makefile.in -+-> ./configure -+-> src/Makefile -+
config.h.in -----+                +-> config.h -----+
                 |
  config.status -+
  config.guess --+

Sie können in der Datei Makefile viele Dinge ändern, beispielsweise können Sie den voreingestellten Installationsort für Dateien ändern, idem Sie die Befehlszeilenoption »./configure --prefix=/usr« benutzen.

Obwohl es nicht erforderlich ist, kann die Aktualisierung der Datei configure und anderer Dateien mittels »autoreconf -i -f« die Kompatibilität der Quellen verbessern. ^[13]

CMake ist ein alternatives Build-System. Sie erkennen solche Quellen an der Datei CMakeLists.txt.

Falls die Quellen der Originalautoren als gentoo-0.9.12.tar.gz existieren, können Sie gentoo als (Quell-)Paketnamen und 0.9.12 als die Versionsnummer der Originalautoren verwenden. Diese werden in der Datei debian/changelog verwandt, die auch später in Abschnitt 4.3, „changelog“ beschrieben wird.

Obwohl dieser einfache Ansatz meistens funktioniert, könnte es sein, dass Sie den Paketnamen und die Versionsnummer der Originalautoren durch Umbenennen der Originalquellen anpassen müssen, damit diese den Debian-Richtlinien und bestehenden Konventionen genügen.

Sie müssen den Paketnamen so wählen, dass er nur aus Kleinbuchstaben (a-z), Ziffern (0-9), Plus- (+) und Minus- (-) Zeichen und Punkten (.) besteht. Er muss mindestens zwei Zeichen lang sein, mit einem alphanumerischen Zeichen beginnen und darf mit keinem existierenden Paket übereinstimmen. Es empfiehlt sich, die Länge unter 31 Zeichen zu halten. ^[14]

Falls die Originalautoren einen generischen Ausdruck wie test-suite für den Namen verwenden, ist es eine gute Idee, ihn umzubenennen, um den Inhalt explizit zu identifizieren und den Namensraum sauber zu halten. ^[15]

Sie sollten die Versionsnummer der Originalautoren so wählen, dass sie nur aus alphanumerischen Zeichen (0-9A-Za-z), Pluszeichen (+), Tilden (~) und Satzpunkten (.) besteht. Sie muss mit einer Ziffer (0-9) beginnen. ^[16] Es ist eine gute Idee, die Länge falls möglich innerhalb von 8 Zeichen zu halten. ^[17]

Falls die Originalautoren kein normales Versionierungsschema wie 2.30.32 sondern eine Art von Datum wie 11Apr29, einen zufälligen Kodenamen oder einen VCS-Hashwert als Teil der Version verwenden, stellen Sie sicher, dass sie das von der Version der Originalautoren entfernen. Diese Informationen können in der Datei debian/changelog festgehalten werden. Falls Sie eine Versionsnummer erfinden müssen, verwenden Sie das Format YYYYMMDD, wie 20110429, als Versionsnummer der Originalautoren. Das stellt sicher, dass dpkg neuere Versionen korrekt als Upgrades interpretiert. Falls Sie in der Zukunft reibungslose Übergänge zu dem normalen Versionsschemata wie 0.1 sicherstellen müssen, verwenden Sie das Format 0~YYMMDD, wie 0~110429, als Versionsnummer der Originalautoren.

Versionsnummern ^[18] können mit dpkg(1) wie folgt verglichen werden:

$ dpkg --compare-versions Ver1 Op Ver2

Die Versionsvergleichsregeln können wie folgt zusammengefasst werden:

Ein schwieriger Fall tritt auf, wenn die Originalautoren gentoo-0.9.12-ReleaseCandidate-99.tar.gz als Vorabveröffentlichung von gentoo-0.9.12.tar.gz veröffentlichen. Sie müssen sicherstellen, dass das Upgrade korrekt funktioniert, indem Sie die Quellen der Originalautoren in gentoo-0.9.12~rc99.tar.gz umbenennen.

Richten Sie die Umgebungsvariablen $DEBEMAIL und $DEBFULLNAME in der Shell ein, damit verschiedene Debian-Wartungswerkzeuge Ihre E-Mail-Adresse und Ihren Namen für Pakete verwenden können. ^[19]

$ cat >>~/.bashrc <<EOF
DEBEMAIL="[email protected]"
DEBFULLNAME="Vorname Nachname"
export DEBEMAIL DEBFULLNAME
EOF
$ . ~/.bashrc

$ cd ~/gentoo
$ wget http://example.org/gentoo-0.9.12.tar.gz
$ tar -xvzf gentoo-0.9.12.tar.gz
$ cd gentoo-0.9.12
$ dh_make -f ../gentoo-0.9.12.tar.gz

Natürlich ersetzen Sie den Dateinamen mit dem Namen Ihres ursprünglichen Quellcode-Archivs. ^[20] Siehe dh_make(8) für Details.

Sie sollten irgendeine Ausgabe sehen, die Sie fragt, welche Art Paket Sie erstellen wollen. Gentoo ist ein »single binary package« — es wird nur ein Binärpaket, d.h. eine .deb-Datei erstellt, also wählen Sie die erste Option (mit der »s«-Taste), überprüfen nochmal die Informationen auf dem Bildschirm und bestätigen mit »EINGABE«. ^[21]

Dieser Aufruf von dh_make erstellt eine Kopie des ursprünglichen Tarballs als gentoo_0.9.12.orig.tar.gz im übergeordneten Verzeichnis, um später die Erstellung eines nicht nativen Debian-Quellpakets mit dem Namen debian.tar.gz zu ermöglichen:

$ cd ~/gentoo ; ls -F
gentoo-0.9.12/
gentoo-0.9.12.tar.gz
gentoo_0.9.12.orig.tar.gz

Bitte beachten Sie zwei entscheidende Merkmale in dem Dateinamen gentoo_0.9.12.orig.tar.gz:

Beachten Sie außerdem, dass viele Schablonendateien im Quellverzeichnis im Unterverzeichnis debian erstellt werden. Diese werden in Kapitel 4, Benötigte Dateien im Verzeichnis debian und Kapitel 5, Andere Dateien im Verzeichnis debian erklärt. Weiterhin sollte Ihnen klar sein, dass das Paketieren kein vollautomatischer Prozess sein kann. Sie müssen die ursprünglichen Quellen für Debian verändern (siehe Kapitel 3, Den Quellcode verändern). Danach müssen Sie die geeigneten Methoden für den Bau des Debian-Paketes verwenden (Kapitel 6, Bau des Pakets), sie testen (Kapitel 7, Überprüfen des Pakets auf Fehler) und hochladen (Kapitel 9, Das Paket hochladen). Alle diese Schritte werden erläutert.

Wenn Sie versehentlich einige der Schablonendateien gelöscht haben, während Sie sie bearbeitet haben, können Sie diese wiederherstellen, indem Sie erneut dh_make mit der Option --addmissing in einem Debian-Quellverzeichnis aufrufen.

Das Aktualisieren eines existierenden Pakets kann kompliziert werden, weil es eventuell ältere Techniken verwendet. Während Sie die Grundlagen lernen, bleiben Sie bei der Erstellung eines neuen Pakets; weitere Erklärungen werden in Kapitel 8, Aktualisieren des Pakets gegeben.

Bitte beachten Sie, dass die Quellen kein in Abschnitt 2.4, „Einfache Bausysteme“ und Abschnitt 2.5, „Beliebte portable Bausysteme“ beschriebenes Bausystem enthalten müssen. Es könnte eine reine Sammlung von graphischen Daten usw. sein. Die Installation der Dateien könnte rein mit debhelper-Konfigurationsdateien wie debian/install (siehe Abschnitt 5.11, „install“) erfolgen.