Table des matières
debian/rulesdebian/controldebian/changelogdebconfdeborphan.orig.tar.{gz,bz2,lzma}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é 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 d'être compatible avec 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, mais obligeraient à 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.
Certains responsables pensent que l'utilisation de fichiers
debian/rules sans assistants est préférable car elle
évite d'avoir à apprendre les subtilité de ces systèmes
d'assistance. Utiliser l'une ou l'autre méthode est entièrement à la
discrétion du responsable d'un paquet qui devrait choisir la méthode qui lui
convient le mieux. De nombreux exemples de fichiers
debian/rules qui n'utilisent pas d'assistants sont
disponibles à l'adresse http://arch.debian.org/arch/private/srivasta/.
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 correctif. Les correctifs sont conservés dans
debian/patches/ et, lorsque le paquet source est
dépaqueté (« unpacked »), les correctifs listées dans
debian/patches/series sont automatiquement
appliquées. 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é 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, via une dépendance à la règle
patch. À l'inverse, les correctifs sont retirés par la
règle clean, via une dépendance à la règle
unpatch.
quilt est la méthodes 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.
Un simple paquet source créera souvent plusieurs paquets binaires, soit pour
fournir plusieurs variantes du même logiciels (par exemple le paquet source
vim) ou pour répartir les fichiers
en plusieurs paquets plus petits au lieu d'un seul paquet monolithique (ce
qui peut permettre à un utilisateur de n'installer que les éléments
nécessaires et donc préserver l'espace disque).
Le second cas est simple à gérer dans le fichier
debian/rules. Il suffit de déplacer les fichiers
nécessaires depuis le répertoire de construction vers l'arborescence
temporaire du paquet. Cela peut se faire avec les commandes
install ou dh_install du paquet
debhelper. Veillez alors à contrôler
les différentes permutations des paquets, afin de pouvoir indiquer les
dépendances inter-paquets appropriées dans
debian/control.
Le premier cas est plus délicat à gérer car il implique des recompilations
multiples du même logiciel avec différentes options de configuration. Le
paquet source vim en est un exemple,
l'ensemble des actions dans le fichier debian/rules
étant géré manuellement.
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, tels 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
<debian-l10n-english@lists.debian.org>.
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és : 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 nominal 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 toute 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, « ceci est le client destiné au serveur toto ») ? ».
Veillez à éviter les erreurs d'orthographe et de grammaire. Vérifier
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 (ceci 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 ?
Il est recommandé d'ajouter l'URL d'accès à la page d'accueil du paquet dans
le champ Homepage de la section Source
du fichier debian/control. L'ajout de cette information
à la description même du paquet est une pratique considérée obsolète.
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 URL http:// pointant
sur la copie navigable par le web du dépôt de gestion de versions utilisé
pour la maintenance du paquet, s'il est disponible.
Cette information est destinée à l'utilisateur final qui voudrait parcourir
le travail en cours sur le paquet (par exemple à la recherche d'un correctif
qui corrige un bogue marqué pending (en attente) dans le
système de suivi des bogues.
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é 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: http://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 de changements
(« changelog »).
Le document de suivi 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ée 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 bogues (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 modification 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 modification 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 FU w/ ancient CRTs.
Trop d'acronymes qui rendent difficile de savoir ce qu'était le « merdoyage » (NdT : FU signifie « fsckup », donc cet exemple ajoute la vulgarité à l'incompréhensibilité) ou comment il a été corrigé.
* 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 clôturer 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 lister les 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érisques et chaque nouveau message utilise un
paragraphe complet plutôt que les mentions succinctes qui prendraient pas
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/.
Il est compressé et porte toujours ce nom même pour les paquets Debian
natifs. Si vous utilisez paquet/NEWS.Debian.gzdebhelper,
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 and
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
instruction qui suivent complètent celles de la Charte Debian.
Les scripts du responsable doivent être idempotent. 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'il 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 [ -x /usr/sbin/install-docs ]; then ...
Pour ne pas coder en dur le chemin d'une commande dans les scripts de responsable, la fonction shell conforme à POSIX suivante peut aider :
pathfind() {
OLDIFS="$IFS"
IFS=:
for p in $PATH; do
if [ -x "$p/$*" ]; then
IFS="$OLDIFS"
return 0
fi
done
IFS="$OLDIFS"
return 1
}
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.
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 présents conseils 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).
Depuis que debconf est apparu dans
Debian, il a été tellement utilisé que de nombreuses critiques ont été
émises à l'encontre de la distribution Debian pour abus d'utilisation de
debconf, avec la nécessité de
répondre à un nombre très important de questions avant d'avoir un quelconque
outil installé.
Les notes d'utilisation doivent être réservées à leur emplacement
naturel : le fichier NEWS.Debian ou
README.Debian. N'utilisez les notes que pour des points
importants qui peuvent directement concerner l'utilisabilité du paquet. Les
notes interrompent l'installation tant qu'elles ne sont pas confirmées et
elles peuvent conduire à des envois de courriers électroniques aux
utilisateurs.
Choisissez soigneusement les questions posées dans les scripts du
responsable. Veuillez consulter la page de manuel debconf-devel(7) pour plus de détails sur les priorités. La plupart des
questions devraient utiliser les priorités intermédiaire
(medium) ou basse (low).
La plupart des responsables de paquets 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
<debian-l10n-english@lists.debian.org>. 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 ensemble
simple permettant la traduction des écrans par des équipes de traductions 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
<debian-i18n@lists.debian.org>. Enfin, elle déclenchera un appel à mise à jour de
traduction aux équipes de traductions (indiquée 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 tel 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
<debian-i18n@lists.debian.org>.
Lorsque le texte d'un écran debconf
est corrigé et que vous avez la certitude
que la modification n'affecte pas les
traductions, pensez aux traducteurs et rendez leur traductions à nouveau
complètes (« unfuzzy »).
Si cela n'est pas fait, l'ensemble de l'écran debconf ne sera plus traduit tant qu'un
traducteur n'aura pas envoyé de mise à jour.
Pour rendre les traductions à nouveau complètes (« unfuzzy »), deux méthodes existent. La première, préventive, effectue recherche et remplacement dans le fichier PO. La seconde utilise gettext pour rendre des chaînes à nouveau complètes (« unfuzzy »).
Méthode préventive :
essayer de trouver un fichier de traduction complet avant la modification :
for i in debian/po/*po; do echo -n $i: ; msgfmt -o /dev/null --statistics $i; done
Le fichier ne montrant que des messages traduits sera utilisé comme fichier de référence. S'il n'y en a aucun (ce qui ne devrait pas arriver si vous collaborez correctement avec les traducteurs), vous devriez utiliser le fichier qui contient le plus de messages traduits ;
identifier la modification nécessaire. Dans l'exemple suivant, supposons que
la modification est une correction de faute de frappe dans le mot
« typo » qui a été écrit « tpyo » par
mégarde. Par conséquent, la modification est
s/tpyo/typo ;
vérifier que la modification ne s'applique bien que là où il faut et pas ailleurs, où la chaîne d'origine est appropriée. Cette remarque s'applique en particulier aux modifications de ponctuation ;
modifier tous les fichiers PO avec sed. L'utilisation de cette commande est recommandée par rapport à n'importe quel éditeur de texte pour garantir que l'encodage des fichiers soit respecté lors de la modification :
cd debian/po for i in *.po; do sed -i 's/tpyo/typo/g' $i; done
modifier le fichier d'écrans debconf
(templates) pour corriger la faute de frappe ;
exécuter la commande debconf-updatepo ;
vérifier le fichier truc.po de référence, ses
statistiques devraient être identiques :
msgfmt -o /dev/null --statistics debian/po/truc.po
si les statistiques du fichier ont changé, vous avez commis une
erreur. Essayez de nouveau ou demandez de l'aide sur la liste de diffusion
<debian-i18n@lists.debian.org>.
Méthode gettext :
déplacer les fichiers PO incomplets à un endroit temporaire. Les fichiers
peuvent être contrôlés avec la commande suivante (qui nécessite
l'installation du paquet gettext) :
for i in debian/po/*po; do echo -n $i: ; msgfmt -o /dev/null --statistics $i; done
déplacer tous les fichiers qui comportent des chaînes approximatives
(« fuzzy ») dans un répertoire temporaire. Les fichiers
qui ne comportent aucune chaîne approximative (seulement des chaînes
traduites ou non traduites) peuvent être laissés en place ;
maintenant et pas avant, vous pouvez
corriger le fichier d'écrans debconf
(templates) en vous assurant à nouveau que les
traductions ne risquent pas d'être affectées (des fautes de frappes, des
erreurs grammaticales et certaines erreurs typographiques ne posent en
général pas de problèmes) ;
exécuter la commande debconf-updatepo. Cette commande va rendre approximatives les traductions de toutes les chaînes modifiées. Cela peut être contrôlé avec la commande ci-dessus à nouveau ;
utiliser la commande suivante :
for i in debian/po/*po; do msgattrib --output-file=$i --clear-fuzzy $i; done
replacer à nouveau dans debian/po les fichiers
contenant des chaînes approximatives à la première étape ;
exécuter la commande debconf-updatepo à nouveau.
Les textes des écrans ne devraient pas faire référence aux éléments
disponibles sur certaines interfaces de debconf. Des phrases telles que « If
you answer Yes » ne signifient rien avec les interfaces
graphiques où des boutons radio sont utilisés pour les questions booléennes.
Les écrans de type string ne devraient pas faire
référence aux valeurs par défaut dans leur description. Cela est tout
d'abord redondant avec les valeurs visibles par les utilisateurs. Mais
également, les valeurs présentées par défaut peuvent être différentes du
choix du responsable (par exemple, lorsque la base de données de debconf a été pré-renseignée).
De manière plus générale, évitez de faire référence à des actions particulières des utilisateurs et donnez simplement des faits.
Vous devriez éviter l'utilisation de la première personne (« I
will do this... » ou « We
recommend... »). L'ordinateur n'est pas une personne et les
écrans de debconf ne parlent pas au
nom des développeurs de Debian. Vous devriez utiliser des constructions
neutres. Pour les personnes familières de la publication scientifiques, il
suffit en général d'adopter le style d'écriture qui y est utilisé. Tentez
cependant d'utiliser la forme active si possible. Par exemple :
« Enable this if... » au lieu de « This can
be enabled if... ».
Les informations présentées dans cette partie proviennent pour l'essentiel de la page de manuel debconf-devel(7).
offre un champ de saisie où l'utilisateur peut entrer n'importe quelle chaîne de caractères.
demande un mot de passe. Ce champ est à utiliser avec précaution car le mot
de passe saisi sera conservé dans la base de données de debconf. Il est conseillé d'effacer cette valeur
de la base de donnes dès que possible.
offre un choix du type « vrai » ou « faux ». N'oubliez pas, c'est bien un choix « vrai » ou « faux », pas « oui » ou « non »...
offre le choix entre différentes valeurs. Les choix doivent être indiqués
dans un champ appelé « Choices ». Les différentes valeurs
doivent être séparées par des virgules et des espaces, comme ceci :
« Choices: yes, no, maybe ».
Si les choix sont traduisibles, le champ « Choices » peut
être marqué traduisible en utilisant « __Choices ». Les
deux tirets bas permettent à chaque choix de devenir une chaîne différente
proposée à la traduction.
Le système po-debconf offre également la possibilité intéressante de ne marquer que certains choix traduisibles. Par exemple :
Template: truc/bidule Type: Select #flag:translate:3 __Choices: PAL, SECAM, Other _Description: TV standard: Please choose the TV standard used in your country.
Dans cet exemple, seule la chaîne « Other » est
traduisible, alors que les autres sont des acronymes qui ne devraient pas
êtres traduits. Seul « Other » sera inclus dans les
fichiers PO et POT.
Le système d'indicateur (« flag ») d'écrans debconf permet de faire de telles choses. La
page de manuel po-debconf(7) documentes toutes ces possibilités.
similaire au type select, mais permet de choisir
plusieurs (ou aucune) valeurs parmi la liste de choix.
plus qu'une vraie question, ce type indique une note affichée aux
utilisateurs. Elle doit être réservée à des informations importantes que
l'utilisateur doit absolument voir, car debconf fera tout pour s'assurer qu'elle soit
visible, en interrompant l'installation jusqu'à ce qu'une touche soit
appuyée, voire en envoyant la note par courrier électronique dans certains
cas.
ce type permet de gérer des messages d'erreur. Il est analogue au type
note. Les interfaces utilisateur peuvent le présenter
différemment (par exemple l'interface cdebconf dessine un
écran à fond rouge au lieu de l'écran bleu habituel).
Il est recommandé d'utiliser ce type pour tout message qui requiert l'attention de l'utilisateur pour procéder à une correction, quelle qu'elle soit.
Les descriptions de modèles 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 feront 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.).
Ce champ doit être utilisé pour les types select et
multiselect. Il contient les choix proposés aux
utilisateurs. Ces choix doivent être séparés par des virgules.
Pas d'indication particulière si ce n'est choisir le type adapté en se référant à la section précédente.
Vous trouverez ici des instruction particulières pour l'écriture du champ
Description (parties courte et longue) selon le type de
modèle.
La description courte est une invite et pas un titre. Il faut éviter la forme interrogative
(« IP Address? ») au profit d'une invite ouverte
(« IP address: »). L'utilisation d'un deux-points final
est recommandée.
La partie longue complète la partie courte. Il est conseillé d'y expliquer ce qui est demandé, plutôt que répéter la même demande. Utilisez des phrases complètes. Un style d'écriture abrégé est déconseillé.
La partie courte devrait utiliser la forme interrogative et se terminer par un point d'interrogation. Un style abrégé est toléré et même encouragé si la question est complexe (les traductions vont être plus longues que la version originale).
Il est important de ne pas faire référence aux spécificités de certaines
interfaces. Une erreur classique est d'utiliser une construction comme
« If you answer Yes... » (« Si vous répondez Oui... »).
La description courte est une invite et pas un titre. N'utilisez pas de constructions comme « Please
choose... » (« Veuillez choisir... »). Les utilisateurs sont
suffisamment intelligents pour comprendre qu'il est nécessaire de choisir
quelque chose.
La description longue complète la partie courte. Elle peut faire référence
aux choix disponibles. Elle peut aussi indiquer que l'utilisateur peut
sélectionner plus d'un choix parmi ceux disponibles, pour les modèles
multiselect (bien que l'interface rende en général cela
tout à fait clair).
La description courte doit être considérée comme un titre.
La partie longue est ce qui sera affiché comme description plus détaillée de la note. Il est déconseillé d'y utiliser un style abrégé.
N'abusez pas de debconf. Les notes sont un des abus
les plus fréquents de debconf. Comme indiqué dans la page de manuel de
debconf, elles devraient être réservées pour avertir les utilisateurs de
problèmes très importants. Les fichiers NEWS.Debian ou
README.Debian sont les endroits appropriés pour
l'information qu'affichent la majorité des notes. Si, à la lecture de ces
conseils, vous envisagez de convertir vos modèles de type note en entrée
dans NEWS.Debian ou README.Debian,
pensez à conserver d'éventuelles traductions existantes.
Si les choix changent souvent, il est suggéré d'utiliser l'astuce
« __Choices ». Avec ce format, chaque choix sera une
chaîne différente proposée à la traduction, ce qui facilite grandement le
travail des traducteurs.
Si la valeur par défaut d'un modèle select peut être
dépendante de la langue utilisée (par exemple s'il s'agit du choix d'une
langue par défaut), pensez à utiliser l'astuce
« _Default ».
Ce champ spécial permet aux traducteur 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.
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 doivent y mettre leur propre choix et non une simple traduction.
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.
Si la valeur par défaut peut dépendre de la langue ou du pays (par exemple
une langue par défaut dans un programme), pensez à utiliser le type
« _Default » documenté dans la page de manuel
po-debconf(7).
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 rend plus
simple 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 version.
Si vous maintenez de la documentation en format XML ou SGML, il est conseillé d'isoler l'information indépendant 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é.
Pouvoir disposer de fichiers config.sub et
config.guess à jour est un point critique pour les
porteurs, particulièrement pour les architectures assez volatiles. De très
bonnes pratiques applicables à tout paquet qui utilise
autoconf ou automake ont été résumées
dans /usr/share/doc/autotools-dev/README.Debian.gz du paquet autotools-dev. Il est fortement recommandé de
lire ce fichier et d'en suivre les recommandations.
Les paquets fournissant des bibliothèques sont plus difficiles à maintenir pour plusieurs raisons. La Charte impose de nombreuses contraintes pour en faciliter la maintenance et garantir que les mises à niveau sont aussi simples que possible quand une nouvelle version amont est disponible. Des erreurs dans une bibliothèque sont susceptibles de rendre inutilisables de très nombreux paquets.
Les bonnes pratiques pour la maintenance de paquets fournissant des bibliothèques ont été rassemblées dans le guide de gestion des paquets de bibliothèques.
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 tels 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 souche.
Plusieurs catégories particulières de paquets utilisent des chartes spécifiques avec les règles et de bonnes pratiques correspondantes.
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 est fréquent qu'un grand nombre de données indépendantes de l'architecture soient fournies avec un programme. Cela peut être par exemple des fichiers audio, un ensemble d'icônes, des motifs de papier-peint ou d'autres fichiers graphiques. Si la taille de ces données est négligeable par rapport à la taille du reste du paquet, il est probablement préférable de laisser l'ensemble dans un seul paquet.
Cependant, si cette taille est importante, vous devriez réfléchir à les
fournir dans un paquet séparé, indépendant de l'architecture
(_all.deb). Cela permet ainsi d'éviter la duplication
des mêmes données dans de nombreux paquets binaires, un par
architecture. Bien que cela ajoute des entrées dans les fichiers
Packages, cela permet d'économiser une place importante
sur les miroirs de Debian. La séparation des données indépendantes de
l'architecture réduit également le temps de traitement de
lintian (voir Section A.2, « Contrôle de paquets (« lint ») ») lorsqu'il est
utilisé sur l'archive Debian en entier.
Si des paramètres régionaux (« locale ») sont nécessaires
pour la construction d'un paquet, vous pouvez créer un fichier temporaire
avec l'astuce suivante.
Si la variable LOCPATH est placée sur l'équivalent de
/usr/lib/locale et LC_ALL sur le nom
des paramètres régionaux à créer, vous devriez pouvoir obtenir le résultat
escompté sans avoir les privilèges du superutilisateur. La séquence
ressemblera alors à :
LOCALE_PATH=debian/tmpdir/usr/lib/locale LOCALE_NAME=en_IN LOCALE_CHARSET=UTF-8 mkdir -p $LOCALE_PATH localedef -i $LOCALE_NAME.$LOCALE_CHARSET -f $LOCALE_CHARSET $LOCALE_PATH/$LOCALE_NAME.$LOCALE_CHARSET # Using the locale LOCPATH=$LOCALE_PATH LC_ALL=$LOCALE_NAME.$LOCALE_CHARSET date
Le programme deborphan permet aux
utilisateurs d'identifier les paquets pouvant être supprimés sans crainte du
système, c'est-à-dire ceux dont aucun paquet ne dépend. Par défaut,
l'utilitaire n'effectue sa recherche que parmi les paquets de bibliothèques
et les sections libs et oldlibs, afin
de traquer les bibliothèques inutilisées. Cependant, avec le paramètre
approprié, il peut rechercher d'autres paquets inutiles.
Par exemple, le paramètre --guess-dummy de la commande
deborphan permet de rechercher les paquets de transition
qui étaient nécessaires lors de mises à niveau mais peuvent être supprimés
sans problème. Pour cela, il recherche la chaîne
« dummy » ou « transitional » dans
leur description courte.
Ainsi, lorsque vous avez besoin de créer un tel paquet, veuillez prendre soin d'ajouter ce texte à sa description courte. Il est facile de trouver des exemples avec les commandes apt-cache search .|grep dummy ou apt-cache search .|grep transitional.
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 et que le
fichier .orig.tar.{gz,bz2,lzma} est strictement
identique à l'archive fournie par l'auteur amont.[5] 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 le plupart des archives amont comme des sources originelles. La stratégie de cette commande est la suivante :
elle extrait l'archive dans un répertoire temporaire :
zcat path/to/nomdupaquet_version-amont.orig.tar.gz | tar xf -
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)
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, le responsable doit construire manuellement une archive
.orig.tar.{gz,bz2,lzma}. 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,lzma} 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,lzma} 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,lzma} reconstruit :
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 ;
ne devrait pas contenir de fichier non distribué par les auteurs amont, ou dont vous avez modifié le contenu ;[6]
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) ;
devrait utiliser
nomdupaquet-version-amont(.orig)
devrait utiliser le taux de compression maximal.
Il est parfois nécessaire de modifier les fichiers binaires contenus dans
l'archive d'origine, ou d'ajouter des fichiers binaires. C'est tout à fait
possible avec les paquets au format « 3.0 (quilt) ». Consultez la page de
manuel
dpkg-source(1)
pour plus de détails. Avec le plus ancien format « 1.0 »,
.diff.gz ne peut pas contenir de fichiers binaires, ce
qui oblige à utiliser uuencode (ou une fonction
similaire) pour les stocker, puis de les reconstruire lors de la compilation
dans debian/rules (et les remettre à leur place).
Un paquet de débogage est un paquet dont le nom se termine par « -dbg », et qui contient des informations supplémentaires que gdb peut utiliser. Puisque les informations de débogage, comme les noms de fonction et de numéro de ligne, sont par défaut absentes des paquets binaires Debian, elles ne pourraient autrement pas être disponible lors de l'utilisation de gdb. Les paquets de débogage permettent aux utilisateurs qui le désirent d'ajouter ces informations de débogage supplémentaires, sans augmenter la taille d'un système normal avec ces informations.
C'est à la discrétion des responsables de paquet de créer ou non un paquet de débogage. Il est conseillé de créer des paquets de débogage pour les bibliothèques, puisque cela peut faciliter le débogage de nombreux programmes liés à ces bibliothèques. Normalement, les paquets de débogage n'ont pas besoin d'être ajoutés systématiquement, sinon la taille de l'archive augmenterait considérablement. En revanche, si un responsable estime que des utilisateurs peuvent avoir souvent besoin d'une version de débogage de son programme, il peut être judicieux de fournir un paquet de débogage. Les programmes faisant partie des applications principales de l'infrastructure, comme Apache ou le serveur X, sont également de bon candidats pour les paquets de débogage.
Certains paquets de débogage peuvent contenir une compilation spécifique de
débogage complète d'une bibliothèque ou d'un autre programme, mais la
plupart peuvent préserver de la place et du temps de compilation en
contenant plutôt séparément les symboles de débogage 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 gardés dans
/usr/lib/debug/, où
cheminchemin 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.
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.
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, il suffit d'appeler dh_strip
--dbg-package=libtruc-dbg, et d'ajouter une entrée à
debian/control pour le paquet de débogage.
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})
[5] 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 l'auteur
amont a distribué à un moment donné. Si une différence
apparaît plus tard (par exemple si l'auteur amont découvre ne pas avoir
utilisé la compression maximale dans sa 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,lzma} pour la même version, il est
même totalement inutile de traiter cette situation comme un bogue.
[6] Avec pour exception particulière, si l'omission de fichiers non libres
provoque une erreur de compilation sans l'aide du fichier de modification
Debian, de pouvoir 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 solliciter l'auteur amont de rendre les
portions non libres facile à séparer du reste des sources.