Chapitre 6. Meilleures pratiques d'empaquetage

Table des matières

6.1. Meilleures pratiques pour debian/rules
6.1.1. Scripts d'assistance
6.1.2. Séparation des correctifs (« patches ») en plusieurs fichiers
6.1.3. Paquets binaires multiples
6.2. Meilleures pratiques pour debian/control
6.2.1. Conseils généraux pour les descriptions de paquets
6.2.2. Résumé, ou description courte, d'un paquet
6.2.3. Description longue
6.2.4. Page d'accueil amont
6.2.5. Emplacement du système de gestion de versions
6.2.5.1. Vcs-Browser
6.2.5.2. Vcs-*
6.3. Meilleures pratiques pour debian/changelog
6.3.1. Entrées de journalisation utiles
6.3.2. Sélection de l’urgence du téléversement
6.3.3. Idées reçues sur les entrées de journalisation
6.3.4. Erreurs usuelles dans les entrées de journalisation
6.3.5. Complément des journaux de modifications dans les fichiers NEWS.Debian
6.4. Meilleures pratiques pour les scripts du responsable
6.5. Gestion de la configuration avec debconf
6.5.1. Proscrire les abus de debconf
6.5.2. Recommandations générales pour les auteurs et les traducteurs
6.5.2.1. Utilisation d'un anglais correct
6.5.2.2. Courtoisie avec les traducteurs
6.5.2.3. Correction (« unfuzzy ») des traductions pour des erreurs typographiques ou de frappe
6.5.2.4. Proscrire toute supposition sur les interfaces utilisateurs
6.5.2.5. Proscrire l'utilisation de la première personne
6.5.2.6. Neutralité en genre
6.5.3. Définition des champs de modèles (« templates »).
6.5.3.1. Type
6.5.3.1.1. string
6.5.3.1.2. password
6.5.3.1.3. boolean
6.5.3.1.4. select
6.5.3.1.5. multiselect
6.5.3.1.6. note
6.5.3.1.7. text
6.5.3.1.8. error
6.5.3.2. Description : descriptions courte et étendue
6.5.3.3. Choices
6.5.3.4. Default
6.5.4. Guide de style spécifique à certains champs de modèle
6.5.4.1. Champ Type
6.5.4.2. Champ Description
6.5.4.2.1. Modèles string et password
6.5.4.2.2. Modèles boolean
6.5.4.2.3. Modèles select et multiselect
6.5.4.2.4. Modèles note
6.5.4.3. Champ Choices
6.5.4.4. Champ Default
6.6. Internationalisation
6.6.1. Gestion des traductions debconf
6.6.2. Documentation internationalisée
6.7. Situations courantes de gestion de paquets
6.7.1. Paquets utilisant autoconf ou automake
6.7.2. Bibliothèques
6.7.3. Documentation
6.7.4. Catégories particulières de paquets
6.7.5. Données indépendantes de l'architecture
6.7.6. Besoin de paramètres régionaux spécifiques lors de la construction
6.7.7. Paquets de transition conformes à deborphan
6.7.8. Meilleures pratiques pour les fichiers .orig.tar.{gz,bz2,xz}
6.7.8.1. Source originelle (« pristine »)
6.7.8.2. Source amont reconstruite
6.7.8.3. Modification de fichier binaire
6.7.9. Meilleures pratiques pour les paquets de débogage
6.7.9.1. Paquets de débogage créés automatiquement
6.7.9.2. Paquets -dbg manuels
6.7.10. Meilleures pratiques pour les métapaquets

La qualité de Debian est largement due à la Charte Debian qui définit explicitement les exigences de base que tous les paquets Debian doivent satisfaire. Cependant, il existe également une expérience générale partagée qui va bien au delà de la Charte Debian et constitue une somme d'années d'expérience dans l'empaquetage. De nombreux contributeurs talentueux ont créé d'excellents outils qui peuvent vous aider, en tant que mainteneur Debian, à créer et maintenir des paquets d'excellente qualité.

Ce chapitre rassemble les meilleures pratiques pour les responsables Debian. La majorité de son contenu est constituée de recommandations plus que d'obligations. Il s'agit essentiellement d'informations subjectives, d'avis et de pointeurs, rassemblés par les développeurs Debian. Il est conseillé d'y choisir ce qui vous convient le mieux.

Les recommandations qui suivent s'appliquent au fichier debian/rules. Comme ce fichier contrôle le processus de construction des paquets et fait le choix des fichiers qui entreront dans ce paquet (directement ou indirectement), il s'agit du fichier dont les responsables s'occupent généralement le plus.

La motivation pour utiliser des scripts d'assistance dans debian/rules est de permettre aux mainteneurs de définir puis utiliser une logique commune pour de nombreux paquets. Si on prend par exemple l'installation d'entrées de menu, il est nécessaire de placer le fichier dans /usr/share/menu (ou /usr/lib/menu pour les fichiers de menu exécutables, si besoin), puis d'ajouter des commandes aux scripts des responsables pour ajouter ou enlever les entrées de menu. Comme cette action est commune à de très nombreux paquets, pourquoi faudrait-il que chaque responsable doivent réécrire ses propres méthodes, bogues compris ? De plus, si jamais le répertoire des menus venait à changer, chaque paquet devrait être modifié.

Les scripts d'assistance s'occupent de ce type de tâche. À condition de suivre les conventions utilisées par le script d'assistance, celui-ci s'occupe de tous les détails. Les modifications dans la Charte peuvent alors être implémentées dans le script d'assistance et les paquets n'ont plus qu'à être reconstruits sans autre modification.

Annexe A, Aperçu des outils du responsable Debian contient un certain nombre d'assistants variés. Le système le plus répandu et (de l'avis général) le plus adapté est debhelper. Des systèmes antérieurs, tels que debmake, étaient monolithiques : ils ne permettaient pas de choisir quelle partie de l'assistant serait utile, et obligeaient à se servir de l'ensemble de l'assistant. A contrario, debhelper est constitué d'un grand nombre de petits programmes dh_* différents. Par exemple, dh_installman installe et compresse les pages de manuel, dh_installmenu installe les fichiers de menu, et ainsi de suite. En conséquence, il offre la possibilité d'utiliser certains des scripts d'assistance tout en conservant des commandes manuelles dans debian/rules.

Pour démarrer avec debhelper, il est conseillé de lire debhelper(1) et de consulter les exemples fournis avec le paquet. dh_make, fourni avec le paquet dh-make (voir Section A.3.2, « dh-make ») peut être utilisé pour convertir un paquet source originel en paquet géré par debhelper. Cette méthode rapide ne doit cependant pas se substituer à une compréhension individuelle des commandes dh_*. Si vous utilisez un assistant, vous devez prendre le temps de le connaître, pour comprendre ses besoins et son comportement.

Les paquets complexes ont souvent de nombreux bogues qui doivent être gérés par le responsable. Si certains de ces bogues sont corrigés par des modifications effectuées directement dans le code source, sans discernement, il peut devenir difficile de retrouver l'origine et la motivation de ces correctifs. Cela peut également rendre bien plus complexe l'intégration d'une nouvelle version amont qui pourrait inclure certains de ces correctifs (mais pas tous). Il est en effet alors quasiment impossible de reprendre le jeu initial de changements (par exemple dans le fichier .diff.gz) et supprimer ceux qui correspondent à des correctifs appliqués par le responsable amont.

Heureusement, avec le format source « 3.0 (quilt) », il est dorénavant possible de séparer des correctifs (« patches ») sans avoir à modifier debian/rules pour configurer un système de correctifs. Les correctifs sont conservés dans debian/patches/ et, lorsque le paquet source est dépaqueté (« unpacked »), les correctifs énumérés dans debian/patches/series sont automatiquement appliqués. Comme le nom le suggère, les correctifs peuvent être gérés avec quilt.

Avec l'ancien format source « 1.0 », il est aussi possible de séparer les correctifs mais un système de correctif dédié doit être utilisé : les correctifs individualisés sont embarqués dans le fichier général de correctifs Debian (.diff.gz), en général à l'intérieur du répertoire debian/. La seule différence est que ces correctifs ne sont pas appliqués directement par dpkg-source mais par la règle build de debian/rules, à travers une dépendance à la règle patch. À l'inverse, les correctifs sont retirés par la règle clean, à travers une dépendance à la règle unpatch.

quilt est l'outil recommandé pour ce besoin. Il effectue l'ensemble des actions mentionnées précédemment et offre la possibilité de gérer des ensembles de correctifs. Veuillez regarder le paquet quilt pour plus d'informations.

D'autres outils existent pour gérer les correctifs, comme dpatch, et le système de correctif intégré à cdbs.

Les conseils qui suivent sont destinés au fichier debian/control. Ils complètent la Charte Debian concernant les descriptions de paquets.

La description d'un paquet telle que définie par le champ correspondant du fichier control, comprend à la fois le résumé et la description longue du paquet. Section 6.2.1, « Conseils généraux pour les descriptions de paquets » donne des indications communes à ces deux parties, Section 6.2.2, « Résumé, ou description courte, d'un paquet » donne des indications spécifiques pour le résumé et Section 6.2.3, « Description longue » donne des indications pour la description.

La description d'un paquet doit être écrite pour son utilisateur moyen, c'est-à-dire la personne qui utilisera et tirera profit du paquet. Par exemple, les paquets de développement sont destinés aux développeurs et leur description peut comporter des détails techniques alors que les applications d'usage plus général, telles que les éditeurs, doivent avoir une description accessible à tout utilisateur.

Un examen général des descriptions de paquets tend à montrer que la plupart d'entre elles ont une orientation fortement technique et ne sont donc pas destinées à l'utilisateur moyen. Sauf dans le cas de paquets destinés à des spécialistes, cela doit être considéré comme un problème.

Une recommandation pour rester accessible à tout utilisateur est d'éviter l'utilisation de jargon. Il est déconseillé de faire référence à des applications ou environnements qui pourraient être inconnus de l'utilisateur : parler de GNOME ou KDE est correct, car la plupart des utilisateurs sont familiers avec ces termes mais parler de GTK+ ne l'est pas. Il est préférable de supposer que le lecteur n'aura pas de connaissance du sujet et, si des termes techniques doivent être utilisés, ils doivent être expliqués.

Il est conseillé de rester objectif. Les descriptions de paquets ne sont pas une plaquette publicitaire, quelles que soient vos opinions personnelles. Le lecteur peut très bien ne pas avoir les mêmes centres d'intérêt que vous.

Les références aux noms d'autres logiciels, de protocoles, normes ou spécifications doivent utiliser leur forme canonique si elle existe. Par exemple, utilisez « X Window System », « X11 » ou « X », mais pas « X Windows », « X-Windows », ou « X Window ». Utilisez « GTK+ » et non « GTK » ou « gtk », « GNOME » et non « Gnome », « PostScript » et non « Postscript » ou « postscript ».

Si vous rencontrez des difficultés pour écrire la description d'un paquet, vous pouvez demander de l'aide ou une relecture sur .

La Charte indique que la ligne de résumé (la description courte) doit être concise, ne doit pas répéter le nom du paquet, mais doit être informative.

La description courte est une expression qui décrit le paquet, pas une phrase complète, donc les conventions de ponctuation sont inappropriées : pas besoin de commencer par une majuscule ou de finir par un point. Elle devrait éviter également la présence d'article défini ou indéfini — « a », « an », ou « the ». Par exemple :

Package: libeg0
Description: exemplification support library

Techniquement, c'est une phrase nominale sans article, par opposition à une une phrase verbale. Une bonne vérification est de pouvoir remplacer le nom du paquet et son résumé dans la phrase :

Le paquet nom fournit {un,une,le,la,l',du,de la} résumé (« the package nom provides {a,an,the,some} résumé »).

Les ensembles de paquets peuvent utiliser un schéma alternatif qui divise la description courte en deux parties, la première une description de l'ensemble et la seconde un résumé du rôle du paquet dans l'ensemble :

Package: eg-tools
Description: simple exemplification system (utilities)
			              
Package: eg-doc
Description: simple exemplification system - documentation

Ces descriptions courtes suivent un modèle modifié. Quand un paquet « nom » possède une description courte « ensemble (rôle) » ou « ensemble - rôle », les éléments peuvent être placés dans la phrase :

Le paquet nom fournit {un,une,le,la,l'} rôle pour {le,la,l'} ensemble (« the package nom provides {a,an,the} rôle for the ensemble »).

La description longue est l'information principale disponible pour les utilisateurs avant d'installer un paquet. Elle devrait fournir toutes les informations nécessaires pour déterminer si le paquet doit être installé. Elle complète le résumé qui est donc supposé avoir été lu précédemment.

La description longue est constituée de phrases complètes.

Le premier paragraphe de cette description devrait tenter de répondre aux questions suivantes : « Que fait ce paquet ? », « Dans quelle tâche aidera-t-il l'utilisateur ? ». Il est important que cette description se fasse de la manière la moins technique possible, sauf si le public auquel est destiné le paquet est par définition technique.

Les paragraphes suivants devraient répondre aux questions : « Pourquoi, en tant qu'utilisateur, ai-je besoin de ce paquet ? », « Quelles autres fonctionnalités ce paquet apporte-t-il ? », « Quelles fonctionnalités et défauts comporte-t-il par rapport à d'autres paquets (par exemple, « si vous avez besoin de X, utilisez plutôt Y ») ? », « Ce paquet est-il lié à d'autres paquets d'une manière non gérée par le système de gestion des paquets (par exemple, « cela est le client destiné au serveur toto ») ? ».

Veillez à éviter les erreurs d'orthographe et de grammaire. Vérifiez l'orthographe avec un outil adapté. Les deux programmes ispell et aspell comportent un mode spécial permettant de contrôler un fichier debian/control files :

ispell -d american -g debian/control
aspell -d en -D -c debian/control

Les utilisateurs attendent en général des descriptions de paquets les réponses aux questions suivantes.

  • Que fait ce paquet ? S'il s'agit d'un additif à un autre paquet, la description de cet autre paquet doit y être reprise.

  • Pourquoi ai-je besoin de ce paquet ? Cela est lié à la remarque précédente, de manière différente (cela est un agent utilisateur pour le courrier électronique, avec une interface rapide et pratique vers PGP, LDAP et IMAP et les fonctionnalités X, Y ou Z).

  • Si ce paquet ne doit pas être installé seul, mais est installé par un autre paquet, cela devrait être mentionné.

  • Si le paquet est expérimental ou ne doit pas être utilisé pour toute autre raison et que d'autres paquets doivent être utilisés à la place, cela doit également être mentionné.

  • En quoi ce paquet diffère-t-il de ses concurrents ? Est-il une meilleure implémentation ? A-t-il plus de fonctionnalités ? Des fonctionnalités différentes ? Pourquoi devrais-je choisir ce paquet ?

Des champs supplémentaires permettent d'indiquer l'emplacement du système de gestion de versions dans debian/control.

La valeur de ce champ doit être une chaîne identifiant sans équivoque l'emplacement du dépôt de gestion de versions utilisé pour la maintenance de ce paquet, s'il est disponible. * doit être remplacé par le système de gestion de versions. Les systèmes suivants sont actuellement gérés par le système de suivi des paquets : arch, bzr (Bazaar), cvs, darcs, git, hg (Mercurial), mtn (Monotone), svn (Subversion). Il est possible d'indiquer plusieurs champs VCS pour le même paquet : ils seront alors tous mentionnés dans l'interface web du système de suivi des paquets.

Cette information est destinée aux utilisateurs qui ont une connaissance suffisante du système de gestion de versions et qui veulent construire une version à jour du paquet depuis les sources du système de suivi. Une autre utilisation possible de cette information pourrait être la construction automatique de la dernière version, dans le système de suivi, d'un paquet donné. À cet effet, l'emplacement pointé devrait éviter d'être lié à une version spécifique et pointer vers la branche principale de développement (pour les systèmes qui ont un tel concept). De plus, l'emplacement indiqué doit être accessible à l'utilisateur final, par exemple en indiquant une adresse d'accès anonyme au dépôt, plutôt qu'une version accessible par SSH.

L'exemple qui suit montre une instance de ce champ pour un dépôt Subversion du paquet vim. Veuillez noter que l'URL a la forme svn:// (au lieu de svn+ssh://) et pointe sur la branche trunk/. Une utilisation des champs Vcs-Browser et Homepage, décrits précédemment, est aussi indiquée.

  Source: vim
  Section: editors
  Priority: optional
  <snip>
  Vcs-Svn: svn://svn.debian.org/svn/pkg-vim/trunk/packages/vim
  Vcs-Browser: https://svn.debian.org/wsvn/pkg-vim/trunk/packages/vim
  Homepage: http://www.vim.org

Les indications de cette partie complètent la Charte Debian pour ce qui concerne les fichiers de journaux des modifications (« changelog »).

Le journal des modifications (« changelog ») présente uniquement les changements intervenus dans la version courante. Il est suggéré de mettre l'accent sur les modifications visibles ou affectant potentiellement les utilisateurs, réalisées depuis la version précédente.

Il est conseillé de mettre l'accent sur ce qui a été modifié, plutôt que comment, par qui et quand elle a été réalisée. Cela dit, il est conseillé, par courtoisie, d'indiquer les auteurs qui ont apporté une aide significative à la maintenance du paquet (par exemple lorsque ces personnes ont envoyé des correctifs).

Il n'est pas indispensable d'indiquer les détails des modifications triviales. Il est également possible de grouper plusieurs modifications sur une même entrée. Cependant, évitez une documentation trop concise pour les modifications majeures. Il est particulièrement conseillé d'être très clair sur les modifications qui affectent le comportement du programme. Pour des explications plus détaillées, vous pouvez aussi utiliser le fichier README.Debian.

Utilisez un anglais simple que la majorité des lecteurs puissent comprendre. Évitez les abréviations et le jargon technique lorsque des modifications permettent la clôture de bogues. Cela est vrai notamment quand vous pensez que les utilisateurs qui les ont envoyés n'ont pas de connaissances techniques importantes. Une formulation polie est à préférer et la vulgarité à prohiber.

Il est parfois souhaitable de faire précéder les entrées du journal des modifications par les noms des fichiers modifiés. Cependant, rien n'oblige à mentionner le moindre fichier modifié, notamment si la modification est simple ou répétitive. L'utilisation de caractères joker est possible.

Ne faites pas de suppositions lorsque vous faites référence à un bogue. Indiquez quel était le problème, comment il a été corrigé et ajoutez la chaîne closes: #nnnnn. Veuillez consulter Section 5.8.4, « Fermeture des rapports de bogue lors des mises à jour » pour plus d'informations.

Les entrées de journal des modifications ne devraient pas documenter les points spécifiques de la réalisation du paquet (« si vous cherchez le fichier toto.conf, il est situé dans /etc/titi ») car les administrateurs et les utilisateurs sont censés avoir l'habitude de la façon dont ces aspects sont traités sur un système Debian. Pensez, par contre, à documenter la modification de l'emplacement d'un fichier de configuration.

Les seuls bogues fermés par une entrée de journal de modifications devraient être ceux qui sont corrigés par la version correspondante du paquet. Fermer de cette manière des bogues qui n'ont aucun rapport avec la nouvelle version est considéré comme une mauvaise habitude. Veuillez consulter Section 5.8.4, « Fermeture des rapports de bogue lors des mises à jour ».

Les entrées du journal des modifications ne devraient pas être utilisées pour des discussions variées avec les émetteurs des rapports de bogue (par exemple : « je n'ai pas d'erreur de segmentation quand je lance toto avec l'option titi, merci d'envoyer plus d'informations »). De même, les considérations générales sur la vie, l'univers et le reste (« désolé, cet envoi m'a pris plus longtemps que prévu, mais j'avais un rhume ») ou encore des demandes d'aide (« la liste de bogues de ce paquet est très longue, merci de me donner un coup de main ») sont à éviter. Ces mentions ne seront généralement pas remarquées par leur public potentiel et peuvent ennuyer les personnes qui cherchent à lire les modifications concrètes du paquet. Voir Section 5.8.2, « Réponses aux bogues » pour plus d'informations sur l'utilisation du système de gestion des bogues.

Une tradition assez ancienne veut que les bogues corrigés dans les NMU soient pris en compte dans la première entrée du journal des modifications d'une nouvelle version construite par le responsable. Depuis l'existence du suivi de version pour le système de gestion de bogues, cette pratique est obsolète à condition de conserver les entrées du journal des modifications des NMU. Il est éventuellement possible de simplement mentionner les NMU dans votre propre entrée de journal des modifications.

Les exemples suivants sont des erreurs usuelles ou des exemples de mauvaises pratiques dans le style des entrées de journaux de modifications (NdT : le texte est volontairement laissé non traduit).

  * Fixed all outstanding bugs.

Cela ne donne évidemment aucune indication au lecteur.

  * Applied patch from Jane Random.

Que faisait ce correctif ?

  * Late night install target overhaul.

Qu'est-ce que cela a amené ? Est-ce que la mention du fait que cela ait été fait tard la nuit doit nous alerter sur la probable mauvaise qualité du code ?

  * Fix vsync fw glitch w/ ancient CRTs.

Too many acronyms (what does "fw" mean, "firmware"?), and it's not overly clear what the glitch was actually about, or how it was fixed.

  * This is not a bug, closes: #nnnnnn.

Il est inutile de faire un nouvel envoi de paquet pour envoyer cette information. Il suffit de simplement utiliser le système de suivi des bogues. De plus, aucune explication n'est donnée sur les raisons qui font que le problème n'est pas un bogue.

  * Has been fixed for ages, but I forgot to close; closes: #54321.

Si, pour une raison donnée, vous avez omis de mentionner un numéro de bogue dans une entrée précédente, ce n'est pas grave : il suffit de clore le bogue normalement dans le système de suivi des bogues. Il est inutile de changer le journal des modifications si on suppose que les explications sur la correction du bogue sont dans le bogue lui-même (cela s'applique également au suivi des bogues des auteurs amont : il est inutile de suivre, dans le journal des modifications, les bogues qu'ils ont corrigés depuis longtemps).

  * Closes: #12345, #12346, #15432

Où est la description ? Si vous ne trouvez pas de message suffisamment explicite, vous pouvez au moins utiliser le titre du rapport de bogue.

Les nouvelles importantes sur les modifications survenues dans un paquet peuvent être placées dans des fichiers NEWS.Debian. Ces nouvelles seront affichées par des outils tels que apt-listchanges, avant tout le reste des modifications. Cette méthode est à privilégier pour diffuser aux utilisateurs d'un paquet les modifications importantes qu'il subit. Il est préférable de l'utiliser plutôt que des notes debconf car ce système permet de revenir lire les fichiers NEWS.Debian après l'installation. Il est également préférable de faire la liste des modifications majeures dans README.Debian, car un utilisateur peut assez facilement ne pas remarquer l'affichage d'une note debconf (Ndt : a contrario, les fichiers NEWS.Debian ne peuvent être traduits).

Le format de ce fichier est analogue à un journal de modifications Debian, mais n'utilise pas d'astérisque et chaque nouveau message utilise un paragraphe complet plutôt que les mentions succinctes qui seraient utilisées dans le journal des modifications. Il est conseillé de traiter le fichier avec dpkg-parsechangelog, ce qui permet d'en vérifier la mise en forme, car il ne sera pas automatiquement modifié pendant la construction du paquet, contrairement au journal des modifications. Voici un exemple de fichier NEWS.Debian réel :

cron (3.0pl1-74) unstable; urgency=low

    The checksecurity script is no longer included with the cron package:
    it now has its own package, checksecurity. If you liked the
    functionality provided with that script, please install the new
    package.

 -- Steve Greenland <stevegr@debian.org>  Sat,  6 Sep 2003 17:15:03 -0500

Le fichier NEWS.Debian est installé sous le nom /usr/share/doc/paquet/NEWS.Debian.gz. Il est compressé et porte toujours ce nom même pour les paquets Debian natifs. Si vous utilisez debhelper, dh_installchangelogs installera les fichiers debian/NEWS automatiquement.

À la différence des journaux de modifications, vous n'avez pas besoin de mettre NEWS.Debian à jour à chaque nouvelle version. Il est suffisant de le mettre à jour quand une information importante doit être diffusée aux utilisateurs. Si vous n'avez pas d'information importante à diffuser, il n'est pas nécessaire d'utiliser un fichier NEWS.Debian avec le paquet. Pas de nouvelles, bonnes nouvelles !

Les scripts du responsable (« maintainer scripts ») sont les fichiers debian/postinst, debian/preinst, debian/prerm et debian/postrm. Ces scripts peuvent prendre en charge les phases d'installation ou de désinstallation non automatiquement gérées par la création ou la suppression de fichiers ou de répertoires. Les instructions qui suivent complètent celles de la Charte Debian.

Les scripts du responsable doivent être idempotents. Cela signifie que vous devez vous assurer que rien de grave ne se produit si un script est lancé deux fois au lieu d'une.

L'entrée et la sortie standard peuvent être redirigées (par exemple dans des tuyaux, ou « pipes ») pour des besoins de journalisation. Il est donc recommandé qu'ils ne soient pas dépendants d'un terminal.

Toute interaction avec l'utilisateur doit être limitée au maximum. Lorsqu'elle est nécessaire, vous devriez utiliser le paquet debconf comme interface. Veuillez noter que l'interaction doit impérativement se faire à l'étape configure du script postinst.

Les scripts du responsable doivent rester aussi simples que possible et utiliser de préférence des scripts shell POSIX stricts. Veuillez noter que si vous avez besoin de spécificités de Bash, vous devez utiliser une ligne « shebang » pour Bash. Les scripts POSIX ou Bash sont encouragés par rapport aux scripts Perl, car debhelper peut alors y ajouter des fonctions.

Si vous modifiez les scripts du responsable, veillez à vérifier la suppression du paquet, la double installation et la purge. Vérifiez qu'un paquet purgé est entièrement éliminé, c'est-à-dire que les fichiers créés, directement ou indirectement dans les scripts du responsable, sont tous supprimés.

Pour vérifier l'existence d'une commande, vous devriez utiliser quelque chose comme :

if which install-docs > /dev/null; then ...

Vous pouvez utiliser cette fonction pour rechercher dans $PATH une commande donnée, passée en paramètre. Elle renvoie « true » (zéro) si la commande est trouvée et « false » dans le cas contraire. Il s'agit de la méthode la plus portable car command -v, type, et which ne sont pas conformes à POSIX.

Bien que which soit acceptable car fourni dans le paquet requis debianutils, il n'est pas disponible sur la partition racine mais est situé dans le répertoire /usr/bin au lieu de /bin, ce qui rend son utilisation impossible si /usr n'est pas encore monté. La plupart des scripts ne seront toutefois pas affectés par cela.

debconf est un système de gestion de configuration utilisable par les divers scripts des paquets (postinst notamment) pour interagir avec l'utilisateur sur des choix à opérer pour la configuration du paquet. Les interactions directes avec l'utilisateur doivent maintenant être évitées en faveur de debconf, notamment pour permettre des installations non interactives dans le futur.

debconf est un outil très pratique mais souvent mal utilisé. De nombreuses erreurs classiques sont mentionnées dans la page de manuel debconf-devel(7). Il est indispensable de lire cette page de manuel avant de décider d'utiliser debconf. Quelques bonnes pratiques sont également indiquées dans le présent document.

Les conseils qui suivent comportent des indications sur le style d'écriture et la typographie, des considérations générales sur l'utilisation de debconf ainsi que des recommandations plus spécifiques relatives à certaines parties de la distribution (le système d'installation notamment).

La plupart des responsables de paquet Debian ne sont pas anglophones. Il n'est donc pas nécessairement facile pour eux d'écrire des écrans correctement.

Pensez à utiliser (voire abuser de) la liste . Faites relire vos écrans.

Des écrans mal écrits fournissent une image négative de votre paquet, de votre travail ou même de Debian en général.

Évitez autant que possible le jargon technique. Si certains termes vous sont familiers, ils peuvent être incompréhensibles à d'autres. Si vous ne pouvez les éviter, tentez de les expliquer (avec la description étendue). Dans ce cas, tentez de faire la part des choses entre simplicité et verbosité.

Les écrans debconf peuvent être traduits. Les paquets debconf et po-debconf fournissent un cadre simple permettant la traduction des écrans par des équipes de traduction ou des traducteurs isolés.

Utilisez des écrans permettant l'utilisation de gettext. Installez le paquet po-debconf sur votre machine de développement et lisez sa documentation (man po-debconf est un bon début).

Évitez de changer les écrans trop souvent. Les modifications de texte ont une incidence sur le travail des traducteurs dont les traductions vont devenir approximatives (« fuzzy »). Une chaîne de caractères devient approximative quand la version originale a été modifiée depuis la traduction, demandant ainsi une mise à jour par un traducteur pour être utilisable. Si les modifications sont mineures, la traduction originale est conservée dans le fichier PO mais marquée fuzzy.

Si vous prévoyez de modifier les écrans d'origine, veuillez utiliser le système de notification podebconf-report-po, fourni avec le paquet po-debconf, pour contacter les traducteurs. La plupart des traducteurs sont réactifs, et inclure leur mise à jour en même temps que les modifications des écrans d'origine vous évitera des envois ultérieurs pour mettre à jour des traductions. Si vous utilisez des écrans se servant de gettext, le nom et l'adresse électronique des traducteurs sont mentionnés dans les en-têtes des fichiers PO et seront utilisés par podebconf-report-po.

Une façon recommandée de se servir de cet utilitaire est :

cd debian/po && podebconf-report-po --call --languageteam --withtranslators --deadline="+10 days"

Cette commande synchronisera d'abord les fichiers PO et POT de debian/po avec les fichiers d'écrans listés en debian/po/POTFILES.in. Ensuite, elle déclenchera un appel à de nouvelles traductions sur la liste de diffusion . Enfin, elle déclenchera un appel à mise à jour de traduction aux équipes de traductions (indiquées dans le champ Language-Team de chaque fichier PO) ainsi qu'au dernier traducteur (indiqué en Last-translator).

La mention d'une date limite aux traducteurs est toujours appréciée, pour leur permettre d'organiser leur travail. Veuillez ne pas oublier que certaines équipes ont formalisé leur processus de traduction et révision de telle sorte qu'un délai inférieur à dix jours n'est pas considéré comme raisonnable. Un délai plus court met trop de pression sur les équipes de traduction et ne devrait être réservé qu'aux modifications mineures.

Dans le doute, vous pouvez également contacter l'équipe de traduction d'une langue donnée (debian-l10n-xxxxx@lists.debian.org) ou la liste de diffusion .

Pour se conformer à notre engagement de diversité et équité, veuillez utiliser des constructions de genre neutre dans votre écriture. Cela signifie éviter les les pronoms tels que il ou elle lors d’une référence à un rôle (tel que « responsable ») dont le genre est inconnu. À la place, vous devriez utiliser une forme plurielle (They singulier).

Les informations présentées dans cette partie proviennent pour l'essentiel de la page de manuel debconf-devel(7).

Les descriptions de modèle comportent deux parties : la partie courte et la partie étendue. La partie courte est celle qui est placée sur la ligne Description du modèle.

La partie courte doit rester courte (une cinquantaine de caractères) afin d'être gérée par la majorité des interfaces de debconf. La garder courte facilite également le travail des traducteurs car les traductions sont souvent plus longues que les textes originaux.

La description courte doit être autonome. Certaines interfaces ne montrent pas la description longue par défaut ou ne la montrent que si l'utilisateur le demande explicitement. Il est ainsi déconseillé d'utiliser des phrases comme « What do you want to do? » (« Que voulez vous faire ? »)

La description courte ne doit pas nécessairement être une phrase entière. C'est une façon de la garder courte et efficace.

La partie longue ne doit pas répéter la partie courte. Si vous ne trouvez pas de partie longue appropriée, réfléchissez un peu plus. Demandez dans debian-devel. Demandez de l'aide. Prenez un cours d'écriture ! La description longue est importante. Si, malgré tout cela, vous ne trouvez rien d'intéressant à ajouter, laissez-la vide.

La partie longue doit utiliser des phrases complètes. Les paragraphes doivent rester courts pour améliorer la lisibilité. Ne placez pas deux idées différentes dans le même paragraphe mais séparez-les en deux paragraphes.

Ne soyez pas trop verbeux. Les utilisateurs ont tendance à ne pas lire les écrans trop longs. Une vingtaine de lignes est une limite que vous ne devriez pas dépasser car, avec l'interface dialog standard, les utilisateurs devront monter et descendre avec des ascenseurs, ce que la plupart des utilisateurs ne font simplement pas.

La partie longue de la description ne devrait jamais comporter de question.

Les parties qui suivent donnent des recommandations spécifiques pour certains types de modèles (string, boolean, etc.).

Vous trouverez ici des instructions particulières pour l'écriture du champ Description (parties courte et longue) selon le type de modèle.

Si la valeur par défaut pour un modèle choisi est susceptible de dépendre de la langue de l’utilisateur (par exemple si le choix concerne la langue), pensez à utiliser l’astuce _Default, documentée dans la page de manuel po-debconf(7).

Ce champ spécial permet aux traducteurs de mettre le choix le plus adapté à leur langue, qui deviendra le choix par défaut quand cette langue est utilisée, alors que le choix par défaut que vous avez mentionné sera utilisé en anglais.

N'utilisez pas de champ Default vide. Si vous ne souhaitez pas avoir de valeur par défaut, n'utilisez pas du tout ce champ.

Quand vous utilisez po-debconf, (et vous devriez, voir Section 6.5.2.2, « Courtoisie avec les traducteurs »), veuillez rendre ce champ traduisible si vous pensez qu'il peut l'être.

Exemple, pris dans le paquet geneweb :

Template: geneweb/lang
Type: select
__Choices: Afrikaans (af), Bulgarian (bg), Catalan (ca), Chinese (zh), Czech (cs), Danish (da), Dutch (nl), English (en), Esperanto (eo), Estonian (et), Finnish (fi), French (fr), German (de), Hebrew (he), Icelandic (is), Italian (it), Latvian (lv), Norwegian (no), Polish (pl), Portuguese (pt), Romanian (ro), Russian (ru), Spanish (es), Swedish (sv)
# This is the default choice. Translators may put their own language here
# instead of the default.
# WARNING : you MUST use the ENGLISH NAME of your language
# For instance, the french translator will need to put French (fr) here.
_Default: English[ translators, please see comment in PO files]
_Description: Geneweb default language:

Veuillez noter l'utilisation de crochets pour autoriser des commentaires internes dans les champs de debconf. Notez également l'utilisation de commentaires qui apparaîtront dans les fichiers de travail des traducteurs.

Les commentaires sont très utiles car l'astuce « _Default » est parfois déroutante pour les traducteurs qui pourraient y mettre leur propre choix.

Cette section fournit des informations générales à destination des développeurs pour simplifier la vie des traducteurs. Vous trouverez plus d'informations à destination des traducteurs et développeurs intéressés par l'internationalisation dans la documentation sur l'internationalisation et la localisation dans Debian.

Comme les porteurs, les traducteurs ont une tâche difficile. Ils travaillent sur de nombreux paquets et doivent collaborer avec de nombreux responsables. De plus, ils n'ont généralement pas la langue anglaise comme langue maternelle et vous devez donc faire preuve d'une patience particulière avec eux.

L'objectif de debconf est de rendre la configuration des paquets plus facile pour les responsables de paquets et pour les utilisateurs. Initialement, la traduction des écrans de debconf était gérée avec debconf-mergetemplate. Cependant, cette technique est désormais obsolète et la meilleure façon d'internationaliser debconf est d'utiliser le paquet po-debconf. Cette méthode simplifie le travail des traducteurs et des responsables, et des scripts de transition sont fournis.

Avec po-debconf, les traductions sont gérées dans des fichiers .po (hérités des techniques de traduction utilisées avec gettext). Des fichiers modèles contiennent les messages d'origine et les champs à traduire y sont marqués spécifiquement. Lorsque le contenu d'un champ traduisible est modifié, l'emploi de la commande debconf-updatepo permet d'indiquer que la traduction a besoin d'une mise à jour par les traducteurs. Ensuite, au moment de la construction du paquet, le programme dh_installdebconf s'occupe des opérations nécessaires pour ajouter le modèle avec les traductions à jour dans les paquets binaires. Vous pouvez consulter la page de manuel de po-debconf(7) pour plus d'informations.

L'internationalisation de la documentation est primordiale pour les utilisateurs mais représente un travail très important. Même s'il n'est pas possible de supprimer tout le travail nécessaire, il est possible de faciliter la tâche des traducteurs.

Si vous maintenez une documentation de quelque taille que ce soit, il sera plus pratique pour les traducteurs d'avoir accès au système de suivi des versions source. Cela leur permet de voir les différences entre deux versions de la documentation et, par conséquent, de mieux voir où les traductions doivent être modifiées. Il est recommandé que la documentation traduite contienne l'indication du système de suivi des versions source qui est utilisé. Un système pratique est fourni par doc-check du paquet debian-installer, qui permet un survol de l'état de la traduction pour toute langue, par l'utilisation de commentaires structurés dans la version du fichier à traduire et, pour le fichier traduit, la version du fichier sur laquelle est basée la traduction. Il est possible d'adapter ce système dans votre propre dépôt de gestion de versions.

Si vous maintenez de la documentation en format XML ou SGML, il est conseillé d'isoler l'information indépendante de la langue et de la définir sous forme d'entités dans un fichier à part qui sera inclus par toutes les traductions. Cela rend par exemple plus simple la maintenance d'URL dans de nombreux fichiers.

Certains outils (par exemple po4a, poxml, ou translate-toolkit) sont spécialisés dans l'extraction des composants traduisibles depuis différents formats. Ils fabriquent des fichiers PO (un format plutôt habituel pour les traducteurs), qui permettent de voir les traductions à mettre à jour quand le document a été modifié.

Veuillez vous assurer que vous suivez la Charte de documentation.

Si votre paquet contient de la documentation construite à partir de fichiers XML ou SGML, il est recommandé de ne pas fournir ces fichiers source dans les paquets binaires. Les utilisateurs qui souhaiteraient disposer des sources de la documentation peuvent alors récupérer le paquet source.

La Charte indique que la documentation devrait être fournie en format HTML. Il est recommandé de la fournir également dans les formats PDF et texte si cela est pratique et si un affichage de qualité raisonnable est possible. Cependant, il est le plus souvent inapproprié de fournir en format texte simple des versions de documentations dont le format source est HTML.

Les manuels les plus importants qui sont fournis devraient être enregistrés avec doc-base lors de leur installation. Veuillez consulter la documentation du paquet doc-base pour plus d'informations.

La Charte Debian (section 12.1) indique que des pages de manuel devraient être fournies avec chaque programme, utilitaire et fonction, et suggère d'en fournir pour les autres éléments comme les fichiers de configuration. Si le travail que vous empaquetez ne fournit pas de telles pages de manuel, veuillez envisager de les écrire pour les ajouter à votre paquet, et les proposer en amont.

Les pages de manuel n'ont pas besoin d'être écrites directement au format troff. Les formats source populaires Docbook, POD et reST peuvent être convertis en utilisant respectivement xsltproc, pod2man et rst2man. De moins grande ampleur, le programme help2man peut aussi être utilisé pour écrire une ébauche.

Plusieurs catégories particulières de paquets utilisent des chartes spécifiques avec leurs règles et leurs pratiques d'empaquetage.

  • Les paquets liés à Perl utilisent une charte Perl. Des exemples de tels paquets qui appliquent cette charte spécifique sont libdbd-pg-perl (module Perl binaire) ou libmldbm-perl (module Perl indépendant de l'architecture).

  • Les paquets liés à Python utilisent une charte Python. Veuillez consulter le fichier /usr/share/doc/python/python-policy.txt.gz du paquet python pour plus d'informations.

  • Les paquets liés à Emacs utilisent une charte Emacs.

  • Les paquets liés à Java utilisent une charte Java.

  • Les paquets liés à OCaml utilisent leur propre charte, que l'on peut trouver dans le fichier /usr/share/doc/ocaml/ocaml_packaging_policy.gz du paquet ocaml. Un bon exemple est fourni par le paquet source camlzip.

  • Les paquets fournissant des DTD XML ou SGML devraient suivre les recommandations données dans le paquet sgml-base-doc.

  • Les paquets Lisp doivent s'enregistrer avec common-lisp-controller, pour lequel plus d'information est disponible dans /usr/share/doc/common-lisp-controller/README.packaging.

Il existe deux sortes différentes d'archives source d'origine. Les sources originelles (« pristine ») et les sources reconstruites (« repackaged »).

La caractéristique définissant une archive source originelle est que le fichier .orig.tar.{gz,bz2,xz} est strictement identique à l'archive fournie par l'auteur amont.[6]. Cela permet d'utiliser des sommes de contrôle pour vérifier que toutes les modifications effectuées entre la version Debian et la version amont sont contenues dans le fichier de différences Debian. De même, si la taille des sources d'origine est importante, les auteurs amont et tous ceux qui disposent de l'archive amont d'origine peuvent économiser du temps de téléchargement s'ils souhaitent contrôler le paquet en détail.

Il n'existe pas de convention universellement acceptée pour la structure de répertoires que devraient adopter les auteurs amont dans les archives qu'ils publient, mais dpkg-source peut de toute manière traiter la plupart des archives amont comme des sources originelles. La stratégie de cette commande est la suivante :

  1. elle extrait l'archive dans un répertoire temporaire :

    zcat path/to/nomdupaquet_version-amont.orig.tar.gz | tar xf -
    
  2. si, après cela, le répertoire temporaire ne contient qu'un seul répertoire sans fichiers, dpkg-source renomme ce répertoire en nomdupaquet-version-amont(.orig). Le nom du répertoire parent de l'archive tar n'a pas d'importance et est oublié ;

  3. si ce n'est pas le cas, l'archive amont a été créée sans répertoire parent (honte à l'auteur amont !). Dans ce cas, dpkg-source renomme le répertoire temporaire lui-même en nomdupaquet-version-amont(.orig).

Vous devriez envoyer les paquets avec une archive source inchangée, dans la mesure du possible. Il existe cependant plusieurs raisons qui peuvent rendre cela impossible. C'est notamment le cas si les auteurs amont ne distribuent pas d'archive tar compressée du tout ou si l'archive amont contient des parties non conformes aux principes du logiciel libre selon Debian, qui doivent être supprimées avant l'envoi.

Dans ces cas, les responsables doivent construire eux-mêmes une archive .orig.tar.{gz,bz2,xz}. Cette archive sera appelée une archive amont reconstruite. Il est important de noter qu'elle reste différente d'un paquet natif. Une archive reconstruite est toujours fournie avec les changements propres à Debian dans un fichier .diff.gz ou .debian.tar.{gz,bz2,xz} séparé et son numéro de version est toujours composé de upstream-version et debian-version.

Il peut exister des cas où il est souhaitable de reconstruire une archive source alors que les auteurs amont fournissent bien une archive .tar.{gz,bz2,xz} qui pourrait être utilisée directement. Le plus évident est la recherche d'un gain de place significatif par recompression ou par suppression de scories inutiles de l'archive source d'origine. Il est important que le responsable exerce avec discernement son propre jugement et soit prêt à le justifier si l'archive source est reconstruite alors qu'elle aurait pu être fournie telle quelle.

Un fichier .orig.tar.{gz,bz2,xz} reconstruit :

  1. devrait être documenté dans le fichier source. Des informations détaillées sur la façon dont les sources ont été obtenues et comment il est possible de refaire l'opération devraient être fournies dans le fichier debian/copyright. Il est également suggéré de fournir une cible get-orig-source dans le fichier debian/rules, qui permette de refaire cette opération, comme indiqué dans la Charte Debian à propos du script de construction principal : debian/rules ;

  2. ne devrait pas contenir de fichier non distribué par les auteurs amont, ou dont vous avez modifié le contenu ;[7]

  3. devrait, sauf si c'est impossible pour des raisons légales, préserver l'intégralité de l'infrastructure de construction et de portabilité fournie par l'auteur amont. Par exemple, il ne faut pas enlever un fichier sous prétexte qu'il ne sert qu'à la compilation sur MS-DOS. De même, un Makefile fourni en amont n'a pas de raison d'être enlevé si la première action de debian/rules est de l'écraser en exécutant un script de configuration.

    (Raison : les utilisateurs Debian ont l'habitude, pour compiler des logiciels sur des systèmes non Debian, de prendre les sources depuis les miroirs Debian plutôt que d'essayer de trouver le dépôt officiel amont) ;

  4. devrait utiliser nomdupaquet-version-amont(.orig) comme nom de répertoire racine de l'archive. Cela permet de distinguer les sources originelles des sources reconstruites ;

  5. devrait utiliser le taux de compression maximal.

Un paquet de débogage est un paquet qui contient des informations supplémentaires que gdb peut utiliser. Puisque les binaires de Debian sont élagués par défaut, les informations de débogage, comme les noms de fonction et les numéros de ligne, ne sont pas disponibles lors de l'utilisation de gdb sur les paquets binaires. Les paquets de débogage permettent aux utilisateurs, qui ont besoin de ces informations de débogage complémentaires, d'ajouter ces informations supplémentaires et d’éviter d’augmenter la taille d'un système normal.

Les paquets de débogage contiennent des symboles de débogage distincts que que gdb peut trouver et charger à la volée lors du débogage d'un programme ou d'une bibliothèque. Par convention dans Debian, ces symboles sont conservés dans /usr/lib/debug/chemin, où chemin est l'arborescence vers l'exécutable ou la bibliothèque. Par exemple, les symboles de débogage pour /usr/bin/truc sont dans /usr/lib/debug/usr/bin/truc, et les symboles de débogage pour /usr/lib/libtruc.so.1 sont dans /usr/lib/debug/usr/lib/libtruc.so.1.

Avant l’introduction des paquets automatiques dbgsym, les paquets de débogage devaient être créés manuellement. Le nom de ces paquets se terminent par -dbg. Il est recommandé de migrer de tels anciens paquets vers les nouveaux paquets dbgsym autant que possible. La procédure de conversion est décrite dans https://wiki.debian.org/AutomaticDebugPackages, mais l’idée générale est d’utiliser le commutateur --dbgsym-migration='pkgname-dbg (<< currentversion~)' de la commande dh_strip.

Cependant, parfois il n’est pas possible de convertir vers les nouveaux paquets dbgsym, ou vous rencontrerez les anciens paquets manuels -dbg dans les archives, donc vous devrez les gérer. Il n’est pas recommandé de créer des paquets -dbg pour les nouveaux paquets, sauf si les paquets automatiques ne fonctionnent pas pour une raison quelconque.

Une raison peut être que les paquets de débogage contiennent une construction spéciale de débogage d’une bibliothèque ou autre binaire. Cependant, généralement séparer des informations de débogage des binaires déjà construits est suffisant et économisera de l’espace au moment de la compilation.

C’est le cas, par exemple, pour les symboles de débogage des extensions de Python. Pour l’instant, la façon correcte d’empaqueter les symboles de débogage des extensions de Python est d’utiliser les paquets -dbg comme décrit dans https://wiki.debian.org/Python/DbgBuilds.

Pour créer des paquets -dbg, le responsable doit les stipuler explicitement dans debian/control.

Les symboles de débogage peuvent être extraits d'un fichier objet à l'aide de objcopy --only-keep-debug. Ensuite les informations de débogage peuvent être supprimées du fichier objet, et objcopy --add-gnu-debuglink peut être utilisé pour préciser le chemin vers le fichier contenant les symboles de débogage. objcopy(1) explique en détail le fonctionnement.

Remarquez que le paquet de débogage devrait dépendre du paquet dont il fournit les symboles de débogage, et que cette dépendance devrait être spécifique à la version. Par exemple

Depends: libtruc (= ${binary:Version})

La commande dh_strip de debhelper permet de créer les paquets de débogage, et prend soin d'utiliser objcopy pour séparer les symboles de débogage à votre place. Si le paquet utilise debhelper/9.20151219, ou une version plus récente, nul besoin de faire quelque chose. debhelper créera les paquets de débogage (sous forme paquet-dbgsym) pour vous sans modifications supplémentaires dans votre paquet source.



[6] Il est impossible d'empêcher les auteurs amont de modifier l'archive qu'ils distribuent sans également incrémenter le numéro de version. Il est donc impossible de garantir qu'une archive originelle est identique à ce que l'auteur amont distribue à un instant donné. Tout ce qu'il est possible de garantir est qu'elle a été identique à ce que les auteurs amont ont distribué à un moment donné. Si une différence apparaît plus tard (par exemple si les auteurs amont découvrent ne pas avoir utilisé la compression maximale dans leur distribution d'origine et la recompresse, c'est tout simplement dommage. Comme il n'existe pas de méthode adaptée pour envoyer un nouveau fichier .orig.tar.{gz,bz2,xz} pour la même version, il est même totalement inutile de traiter cette situation comme un bogue.

[7] Avec pour exception particulière, si l'omission de fichiers non libres provoque une erreur de compilation du source sans l'aide du diff Debian, il peut être pertinent de modifier les fichiers pour enlever les portions non libres, ou d'expliquer la situation dans un fichier README.source à la racine de l'arbre des sources. Veuillez dans ce cas encourager l'auteur amont à rendre les portions non libres faciles à séparer du reste des sources.