Chapitre 5. Autres fichiers dans le répertoire debian

gentoo for Debian
-----------------
<possible notes regarding this package - if none, delete this file>
 -- Josip Rodin <[email protected]>, Wed, 11 Nov 1998 21:02:14 +0100

Si vous n'avez rien à documenter, effacez ce fichier, consultez dh_installdocs(1).

Une des choses les plus irritantes à propos des logiciels est de consacrer beaucoup de temps et d'efforts pour configurer un programme, et de voir une seule mise à jour détruire tous ses changements. Debian résout ce problème en marquant ces fichiers de configuration comme des conffiles. ^[54] Lors de la mise à jour d'un paquet, une question sera posée, permettant de garder les anciens fichiers de configuration ou non.

dh_installdeb(1) considère automatiquement tous les fichiers du répertoire /etc comme des conffiles, donc si tous les fichiers de configuration de votre programme sont dans ce répertoire, il n'est pas nécessaire de les indiquer dans ce fichier. Pour la plupart des paquets, le seul endroit devant contenir des conffiles est /etc, donc ce fichier ne devrait pas exister.

Si votre programme utilise des fichiers de configuration, mais les réécrit aussi de son côté, il vaut mieux ne pas les marquer comme conffiles, parce que dpkg va alors interroger les utilisateurs pour vérifier les modifications tout le temps.

Si le programme que vous empaquetez force tous les utilisateurs à modifier les fichiers de configuration du répertoire /etc, il y a deux façons classiques de ne pas les marquer comme conffiles, et garder dpkg silencieux :

Pour obtenir des renseignements sur les scripts du responsable, consultez Section 5.18, « {post,pre}{inst,rm} ».

Les fichiers énumérés dans un fichier install n'ont pas besoin que leurs répertoires soient créés avant, consultez Section 5.11, « install ».

Il est préférable d'essayer d'exécuter l'installation, et d'utiliser seulement ce recours si vous avez des problèmes. Il n'y a pas de barre oblique (/) au début des noms de répertoire dans la liste du fichier dirs.

Document: gentoo
Title: Gentoo Manual
Author: Emil Brink
Abstract: This manual describes what Gentoo is, and how it can be used.
Section: File Management
Format: HTML
Index: /usr/share/doc/gentoo/html/index.html
Files: /usr/share/doc/gentoo/html/*.html

Pour obtenir plus de renseignements sur l'installation de documentation supplémentaire, consultez Section 3.3, « Installation des fichiers à leur emplacement ».

Si des fichiers doivent être installés dans le paquet mais que make install normal ne le fait pas, il faut ajouter les noms de fichiers et leur destination dans ce fichier install. Ils sont installés par dh_install(1).^[55] Vous devriez d'abord vérifier s'il n'y a pas un outil plus approprié à utiliser. Par exemple, les documents devraient être dans le fichier docs et non dans celui-ci.

Ce fichier install possède une ligne par fichier installé, avec le nom du fichier (par rapport au répertoire de construction principal) suivi d'une espace puis du répertoire d'installation (par rapport au répertoire d'install). Par exemple, si un binaire src/truc n'est pas installé, le fichier install pourrait ressembler à :

src/truc usr/bin

Cela signifie que lors de l'installation du paquet, il y aura une commande exécutable /usr/bin/truc.

Ce fichier install peut renseigner seulement le nom du fichier sans le répertoire d'installation quand le chemin relatif n'est pas modifié. Ce format est normalement utilisé pour un gros paquet qui découpe le résultat de la construction en plusieurs paquets binaires à l'aide de paquet-1.install, paquet-2.install, etc.

La commande dh_install finira par chercher les fichiers dans debian/tmp, s'il ne les trouve pas dans le répertoire courant (ou quelque soit l'endroit où il lui a été demandé de chercher avec --sourcedir).

Les fichiers postinst, preinst, postrm, et prerm ^[57] sont nommés scripts du responsable. Ces scripts sont placés dans la zone de contrôle du paquet et sont exécutés par dpkg lorsque le paquet est installé, mis à jour ou supprimé.

En tant que responsable débutant, vous devriez éviter de modifier manuellement les scripts du responsable parce qu'ils ont tendance à être complexes. Pour obtenir plus de renseignements, consultez dans la Charte Debian, chapitre 6 « scripts du responsable et procédure d'installation » et examinez les fichiers d'exemple fournis par dh_make.

Si vous préférez n'en faire qu'à votre tête en créant vos propres scripts du responsable pour un paquet, vous devriez les essayer non seulement lors de l'installation et la mise à jour, mais aussi pour la désinstallation et la purge.

Les mises à niveau vers de nouvelles versions devraient être silencieuses et non intrusives (les utilisateurs existants ne devraient pas remarquer la mise à niveau à part en constatant la résolution de vieux bogues et peut-être l'arrivée de nouvelles fonctionnalités).

Lorsque la mise à niveau est forcément intrusive (par exemple des fichiers de configuration dispersés dans plusieurs répertoires personnels avec des structures complètement différentes), vous pouvez envisager en dernier recours de basculer le paquet vers un état de repli sûr (par exemple en désactivant un service) et en fournissant la documentation adéquate conformément à la Charte Debian (README.Debian et NEWS.Debian). N'embêtez pas l'utilisateur avec des notes debconf déclenchées par les scripts du responsable lors des mises à niveau.

Le paquet ucf fournit un dispositif à la conffile pour conserver les modifications des utilisateurs pour les fichiers qui n'ont pas été marqués comme conffiles comme ceux gérés par les scripts du responsable. Cela permet de réduire les problèmes associés à ces fichiers.

Ces scripts du responsable font partie des améliorations de Debian qui expliquent pourquoi les gens choisissent Debian. Prenez garde de ne pas les transformer en source d'agacement.

L'empaquetage de bibliothèque n'est pas facile pour un mainteneur débutant, et devrait être évité. Cela dit, si le paquet fournit des bibliothèques, des fichiers debian/paquet.symbols devraient exister. Consultez Section A.2, « Gestion de debian/paquet.symbols ».

Le format du fichier watch est documenté dans la page de manuel uscan(1). Le fichier watch configure le programme uscan (dans le paquet devscripts) pour surveiller le site sur lequel vous avez obtenu les sources. C'est également utilisé par le service Debian Package Tracker.

Voici ce qu'il contient :

# watch control file for uscan
version=3
http://sf.net/gentoo/gentoo-(.+)\.tar\.gz debian uupdate

Normalement, avec un fichier watch, la page servie à l'URL http://sf.net/gentoo est téléchargée pour chercher des liens sous la forme <a href=...>. Le nom de base (juste après la dernière /) de chaque URL liée est comparé au motif de l'expression rationnelle Perl gentoo-(.+)\.tar\.gz (consultez perlre(1)). Parmi les fichiers correspondants, celui avec le plus grand numéro de version est téléchargé puis le programme uupdate est exécuté pour créer une arborescence source mise à jour.

Bien que ce soit vrai pour les autres sites, le service de téléchargement de SourceForge en http://sf.net est une exception. Quand le fichier watch comporte une URL correspondant au motif d'expression rationnelle ^http://sf\.net/, le programme uscan le remplace par http://qa.debian.org/watch/sf.php/ et applique ensuite cette règle. Le service de redirection en http://qa.debian.org/ est conçu pour offrir un service stable vers le fichier voulu pour les motifs watch de la forme http://sf.net/projet/nom-d-archive-(.+)\.tar\.gz. Le but est de résoudre le problème lié au fréquent changement d'URL SourceForge.

Si la source propose une signature cryptographique pour l’archive, il est recommandé de vérifier son authenticité en utilisant l’option pgpsigurlmangle comme expliqué dans uscan(1).

Le récent format source 3.0 (quilt) enregistre les modifications dans un ensemble de correctifs quilt dans debian/patches. Ces changements sont alors appliqués automatiquement lors de l'extraction du paquet source. ^[58] Les modifications Debian sont simplement conservées dans une archive debian.tar.gz contenant tous les fichiers du répertoire debian. Ce nouveau format permet d'inclure des fichiers binaires comme des icônes PNG sans bidouillage. ^[59]

Quand dpkg-source extrait un paquet source au format 3.0 (quilt), il applique automatiquement tous les correctifs énumérés dans debian/patches/series. Vous pouvez éviter que les correctifs soient appliqués à la fin de l'extraction avec l'option --skip-patches.

Les fichiers créés automatiquement dans l'arborescence source peuvent être assez agaçants pour l'empaquetage puisqu'ils sont à l'origine de grands fichiers de correctif sans signification. Des modules personnalisés comme dh_autoreconf permettent d'atténuer ce problème comme décrit en Section 4.4.3, « Personnalisation du fichier rules ».

Vous pouvez fournir une expression rationnelle Perl en argument de l'option --extend-diff-ignore de dpkg-source(1) pour ignorer les modifications faites aux fichiers créés automatiquement lors de la création du paquet source.

Comme solution générique pour aborder ce problème de fichiers créés automatiquement, vous pouvez enregistrer ces arguments d'option de dpkg-source dans le fichier source/options du paquet source. L'exemple suivant permet de sauter la création de fichiers de correctif pour config.sub, config.guess et Makefile :

extend-diff-ignore = "(^|/)(config\.sub|config\.guess|Makefile)$"

Le nouveau format source 3.0 (quilt) conserve les correctifs dans les fichiers debian/patches/* en utilisant la commande quilt. Ces correctifs et les autres données de paquet qui sont tous contenus dans le répertoire debian sont empaquetés dans le fichier debian.tar.gz. Puisque la commande dpkg-source peut gérer les correctifs au format quilt dans le source 3.0 (quilt) sans le paquet quilt, il n'est pas nécessaire d'ajouter quilt à Build-Depends. ^[60]

La commande quilt est expliquée en quilt(1). Elle enregistre les modifications des sources comme une pile de fichiers correctifs -p1 dans le répertoire debian/patches et l'arborescence source n'est pas modifiée en dehors du répertoire debian. L'ordre d'application de ces correctifs est enregistré dans le fichier debian/patches/series. Vous pouvez appliquer (« push »), enlever (« pop »), et rafraîchir (« refresh ») les correctifs facilement. ^[61]

En Chapitre 3, Modification du code source, trois correctifs ont été créés dans debian/patches.

Puisque les correctifs Debian sont localisés en debian/patches, veuillez vous assurer d'avoir configuré correctement la commande dquilt conformément à la description en Section 3.1, « Configuration de quilt ».

Quand quelqu'un (éventuellement vous-même) fournit un correctif toto.patch par la suite, la modification d'un paquet source 3.0 (quilt) est assez simple :

$ dpkg-source -x gentoo_0.9.12.dsc
$ cd gentoo-0.9.12
$ dquilt import ../toto.patch
$ dquilt push
$ dquilt refresh
$ dquilt header -e
... description du correctif

Les correctifs conservés au nouveau format source 3.0 (quilt) doivent être sans approximation (« fuzz »). Vous pouvez vous en assurer avec dquilt pop -a; while dquilt push; do dquilt refresh; done.