Chapitre 2. Premiers pas

Veuillez remarquer que le caractère séparant paquet de version a été modifié : le tiret (-) dans le nom de l'archive source a été remplacé par un tiret bas (_) dans les noms de fichier de paquet Debian.

Dans les noms de fichier précédents, la partie paquet du nom de fichier est remplacée par le nom du paquet, la partie version par la version amont, la partie révision par la révision Debian et la partie arch par l'architecture du paquet, conformément à la Charte Debian. ^[5]

Chaque étape de ces grandes lignes sera expliquée avec des exemples détaillés dans les sections suivantes.

Si le paquet existe déjà, et bien, installez-le :-). S'il se trouve qu'il est orphelin (c'est à dire si son responsable est Debian QA Group), vous devriez pouvoir le reprendre s'il est toujours disponible. Vous pouvez aussi adopter un paquet dont le responsable a rempli une demande d'adoption (« Request for Adoption » ou RFA).^[6]

Plusieurs ressources d'état de propriété de paquet Debian existent :

En remarque, il est important de souligner que Debian possède déjà des paquets pour quasiment tous les types de programme, et que le nombre de paquets déjà dans l'archive Debian est bien plus important que le nombre de personnes ayant les droits suffisants pour envoyer les mises à jour. Par conséquent, contribuer aux paquets existants déjà dans l'archive est bien plus apprécié (avec plus de chances d'être parrainé) des autres développeurs ^[7]. Il est possible de contribuer de plusieurs façons comme suit :

Si vous pouvez adopter le paquet, récupérez les sources (avec quelque chose comme apt-get source nomdepaquet) et examinez-les. Malheureusement ce document n'inclut pas d'informations exhaustives sur l'adoption de paquets. Heureusement, vous ne devriez pas avoir de problèmes à comprendre comment le paquet fonctionne, puisque quelqu'un s'est déjà occupé de la configuration initiale pour vous. Continuez quand même à lire ce document, une bonne partie des conseils qui suivent seront applicables dans votre cas.

Si le paquet est nouveau, et que vous aimeriez le voir dans Debian, procédez comme suit :

Bien sûr, cette dernière remarque n'est qu'une mesure de sécurité, et n'a pour but que de vous préserver d'utilisateurs fous de rage si vous faites une erreur dans un démon setuid… Quand vous aurez plus d'expérience dans la création de paquets, vous pourrez empaqueter un logiciel de ce type.

En tant que nouveau responsable vous devriez acquérir de l'expérience dans l'empaquetage de paquets plus faciles plutôt que de créer des paquets compliqués :

Ce n'est pas si difficile d'empaqueter des paquets plus compliqués, mais cela exige un peu plus de connaissances. Vous devriez chercher de l'aide particulière pour chaque fonctionnalité compliquée. Par exemple, certains langages ont leur propre sous-charte :

Un autre vieux proverbe latin s'applique : « fabricando fit faber » (c'est en forgeant que l'on devient forgeron). La pratique et l'expérience de toutes les étapes de l'empaquetage sont vivement recommandées avec des paquets simples lors de la lecture de ce tutoriel. Une archive source amont triviale comme hello-sh-1.0.tar.gz créée comme suit peut servir de bon point de départ : ^[8]

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

Si les sources du programme sont disponibles dans un autre format d'archive (par exemple, le programme se termine par .Z ou .zip ^[9]), vous devriez le décompresser à l'aide des outils adéquats et le recompresser.

Si le programme est distribué avec du contenu non compatible avec les principes du logiciel libre selon Debian, vous devriez aussi le décompresser pour enlever ce contenu et le recompresser avec une version amont modifiée contenant dfsg.

Comme exemple, le programme nommé gentoo (un gestionnaire de fichiers utilisant GTK+) sera utilisé. ^[10]

Créez un sous-répertoire dans votre répertoire personnel nommé debian ou deb ou quoi que ce soit d'adéquat (par exemple le nom du programme, ~/gentoo, ferait l'affaire dans ce cas). Placez l'archive téléchargée dedans, et décompressez-la avec tar xzf gentoo-0.9.12.tar.gz. Assurez-vous qu'aucun message d'avertissement ne se produit, même sans importance, sinon les outils de décompression d'autres personnes pourraient ne pas gérer ces problèmes, et être incapables de les décompresser. La ligne de commande de votre interpréteur devrait ressembler à ceci :

$ 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

Maintenant vous avez un autre sous-répertoire, nommé gentoo-0.9.12. Allez dans ce répertoire et lisez attentivement la documentation fournie. Il s'agit généralement de fichiers nommés README*, INSTALL*, *.lsm ou *.html. Vous devez trouver les instructions pour compiler et installer le programme (elles supposent très probablement que vous voulez l'installer dans le répertoire /usr/local/bin ; ce n'est pas le cas, mais ce point sera traité plus tard en Section 3.3, « Installation des fichiers à leur emplacement »).

Vous devriez commencer la création du paquet avec un répertoire source complètement propre (originel), ou simplement avec les sources fraîchement décompressées.

Des programmes simples sont généralement fournis avec un fichier Makefile et peuvent être compilés en appelant simplement make. ^[11] Certains d'entre eux gèrent make check, qui exécute des vérifications internes. L'installation dans les répertoires de destination se fait normalement avec make install.

Maintenant, essayez de compiler et d'exécuter le programme, pour vous assurer qu'il fonctionne correctement et ne casse rien d'autre quand il est installé ou utilisé.

Sachez aussi que vous pouvez généralement utiliser make clean (ou mieux, make distclean) pour nettoyer le répertoire de compilation. Parfois, make uninstall peut être utilisé pour retirer tous les fichiers installés.

De nombreux logiciels libres sont écrits en C et C++. Beaucoup d'entre eux utilisent les Autotools ou CMake pour les rendre portables sur différentes architectures. Ces outils de construction doivent être utilisés pour créer les Makefile et d'autres fichiers sources nécessaires. Ensuite, de tels programmes sont construits en utilisant l'habituel make; make install.

Les Autotools sont les outils de construction GNU. Ils comprennent Autoconf, Automake, Libtool et gettext. Vous pouvez reconnaître de telles sources à l'aide des fichiers configure.ac, Makefile.am et Makefile.in. ^[12]

La première étape du travail des Autotools est généralement faite par les auteurs amont qui exécutent autoreconf -i -f dans le répertoire des sources et distribuent les fichiers créés avec les sources.

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

Modifier les fichiers configure.ac et Makefile.am nécessite un peu de connaissance de autoconf et automake. Consultez info autoconf et info automake.

La deuxième étape du travail des Autotools est habituellement que les utilisateurs se procurent ces sources et exécutent ./configure && make dans le répertoire des sources pour compiler le programme en une commande exécutable binaire.

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

Vous pouvez modifier plein de choses dans le fichier Makefile ; vous pouvez, par exemple, modifier l'emplacement par défaut du répertoire d'installation en utilisant la commande ./configure --prefix=/usr.

Bien que ce ne soit pas nécessaire, mettre à jour configure et les autres fichiers avec autoreconf -i -f peut améliorer la compatibilité des sources. ^[13]

CMake est un système de construction alternatif. De tels sources peuvent être reconnus avec le fichier CMakeLists.txt.

Si le code source amont est distribué sous le nom de gentoo-0.9.12.tar.gz, vous pouvez prendre gentoo comme nom de paquet (source) et 0.9.12 comme version amont. Ces désignations seront aussi utilisées dans le fichier debian/changelog décrit plus loin dans Section 4.3, « changelog ».

Même si cette simple approche fonctionne la plupart du temps, vous pourriez devoir remplacer nom de paquet et version amont en renommant les sources amont afin de suivre la Charte Debian et les conventions existantes.

Le nom de paquet ne doit contenir que des lettres minuscules (a-z), des chiffres (0-9), les signes plus (+) ou moins (-) et des points (.). Il doit comporter au moins deux caractères, commencer par un caractère alphanumérique et ne doit pas être déjà utilisé. Il est préférable de garder sa longueur inférieure à trente caractères. ^[14]

Si l'amont utilise quelques termes génériques comme test-suite comme nom, il vaut mieux les renommer pour identifier son contenu de façon explicite et éviter de polluer l'espace de noms. ^[15]

La version amont ne devrait contenir que des caractères alphanumériques (0-9A-Za-z), plus (+), tildes (~) et points (.). Elle doit commencer par un chiffre (0-9). ^[16] Il est conseillé de garder sa longueur inférieure à huit caractères si possible. ^[17]

Si l'amont n'utilise pas un système d'affectation de version classique comme 2.30.32 mais utilise plutôt une sorte de date comme 11Apr29, un nom de code aléatoire ou une somme de hachage d'un système de gestion de versions dans la version, assurez-vous d'enlever ces parties de la version amont. Ces renseignements peuvent être enregistrés dans le fichier debian/changelog. Si vous devez inventer une version, utilisez le format AAAAMMJJ, par exemple 20110429, comme numéro de version. Cela garantit que dpkg interprète correctement les futures versions comme des mises à niveau. Pour permettre des mises à niveau en douceur vers un schéma de version classique comme 0.1 dans l'avenir, utilisez plutôt la forme 0~AAMMJJ comme 0~110429 pour la version amont.

Les chaînes de version ^[18] peuvent être comparées en utilisant dpkg(1) comme suit :

$ dpkg --compare-versions ver1 op ver2

La règle de comparaison de versions peut être résumée par :

Un cas délicat se produit quand une version amont gentoo-0.9.12-ReleaseCandidate-99.tar.gz est publiée comme une préversion de gentoo-0.9.12.tar.gz. Vous devez vous assurer que la mise à niveau fonctionne correctement en renommant les sources amont en gentoo-0.9.12~rc99.tar.gz.

Configurez les variables d'environnement de l'interpréteur de commandes $DEBEMAIL et $DEBFULLNAME de telle sorte que plusieurs outils de maintenance Debian identifient l’adresse électronique et le nom à utiliser pour les paquets : ^[19]

$ cat >>~/.bashrc <<EOF
DEBEMAIL="your.email.address@example.org"
DEBFULLNAME="Prénom Nom"
export DEBEMAIL DEBFULLNAME
EOF
$ . ~/.bashrc

$ cd ~/gentoo
$ wget http://www.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

Bien sûr, remplacez le nom de fichier par celui de votre archive source d'origine. ^[20] Consultez dh_make(8) pour plus de précisions.

Vous devriez voir quelques questions sur le type de paquet vous voulez créer. Gentoo est un paquet binaire simple — il ne crée qu'un paquet binaire, c'est-à-dire un seul fichier .deb — donc la première option sera sélectionnée (avec la touche s). Une fois l'information vérifiée sur l'écran, confirmez en pressant Entrée. ^[21]

Cette exécution de dh_make crée une copie de l'archive amont en gentoo_0.9.12.orig.tar.gz dans le répertoire parent pour permettre ensuite la création d'un paquet source Debian non natif nommé debian.tar.gz plus tard :

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

Veuillez remarquer deux caractéristiques du nom de fichier gentoo_0.9.12.orig.tar.gz :

Vous devriez aussi remarquer que de nombreux fichiers modèles sont créés dans les sources sous le répertoire debian. Ce sera expliqué en Chapitre 4, Fichiers nécessaires dans le répertoire debian et Chapitre 5, Autres fichiers dans le répertoire debian. Vous devriez aussi comprendre que l'empaquetage ne peut pas être un processus complètement automatisé. Vous aurez à modifier les sources amont pour Debian (consultez Chapitre 3, Modification du code source). Après cela, vous devez utiliser les méthodes correctes pour construire les paquets Debian (Chapitre 6, Construction du paquet), les vérifier (Chapitre 7, Contrôle des erreurs du paquet) et les envoyer (Chapitre 9, Envoi de paquet). Toutes ces étapes seront expliquées.

Si vous effacez par mégarde quelques fichiers modèles en travaillant dessus, vous pouvez les retrouver en exécutant de nouveau dh_make avec l'option --addmissing dans une arborescence de paquet Debian.

La mise à jour d'un paquet existant peut devenir compliquée puisqu'il pourrait utiliser d'anciennes techniques. Lors de l'apprentissage des bases, veuillez vous en tenir aux cas d'empaquetage récents ; des explications sont données plus loin en Chapitre 8, Mise à jour de paquet.

Veuillez noter que le fichier source ne doit pas forcément contenir de système de construction comme en Section 2.4, « Systèmes de construction simples » et Section 2.5, « Systèmes de construction portables répandus ». Il peut simplement s'agir d'un ensemble de données graphiques par exemple. L'installation de fichiers peut être effectuée en utilisant juste les fichiers de configuration de debhelper comme debian/install (consultez Section 5.11, « install »).