$FreeBSD$
FreeBSD est une marque déposée de la fondation FreeBSD.
Plusieurs désignations utilisées par les constructeurs et vendeurs pour distinguer leurs produits sont mentionnées comme des marques déposées. Lorsqu'elles apparaissent dans ce document et que le projet FreeBSD est au courant de cette mention, la désignation est suivie du symbole “™” ou du symbole “®”.
La collection des logiciels portés (appelé Ports en anglais) est le fruit d'un travail en perpétuelle évolution. Nous voulons fournir à nos utilisateurs une collection de logiciels tiers qui soit facile à utiliser, à jour, et de grande qualité. Pour nous aider à atteindre ce but, nous avons besoin que des personnes donnent de leur temps libre et participent à cet effort.
Tout le monde peut participer et il existe de nombreuses possibilités pour ce faire. Contribuer aux logiciels portés est un excellent moyen de "donner quelque chose en retour" au projet. Que vous cherchiez à vous impliquer de manière continue ou bien juste un défi amusant pour chasser l'ennui un jour de pluie, nous aimerions beaucoup avoir votre aide!
En tant que volontaire, ce que vous faites est limité uniquement par les barrières que vous vous imposez vous-même. Cependant, nous vous demandons d'être conscient de ce que les autres membres de la communauté FreeBSD attendent de vous. Il serait souhaitable que vous le preniez en compte avant de vous décider à vous porter volontaire.
Vous pouvez contribuer facilement à la mise à jour de la collection des logiciels portés et à son maintien en bon état en utilisant une des possibilités suivantes :
Trouvez un logiciel sympa ou utile et créez un portage de celui-ci.
Il existe un grand nombre de portages qui n'ont pas de mainteneur. Devenez un mainteneur et adoptez un portage.
Si vous avez créé ou adopté un portage, soyez conscient de vos devoirs en tant que mainteneur.
Si vous êtes à la recherche d'un petit défi vous pouvez corriger un bogue ou un portage déficient.
Un autre document est à votre disposition pour vous guider dans la création (et la mise à jour) d'un portage : le Guide du Porteur de logiciels. Ce guide est la meilleure référence pour travailler avec le système des logiciels portés. Il fournit des détails sur la manière dont fonctionne ce système et expose les pratiques recommendées.
Prendre la relève en maintenant des portages abandonnés est un excellent moyen de s'impliquer. Les portages non maintenus sont mis à jour et réparés uniquement lorsque quelqu'un se porte volontaire pour travailler dessus. Il existe un grand nombre de portages non maintenus. C'est une bonne idée de commencer par adopter un portage que vous utilisez régulièrement.
Les portages non maintenus ont leur MAINTAINER assigné à ports@FreeBSD.org. Une liste des portages non maintenus ainsi que de leurs bogues actuels et leurs rapports de problèmes peuvent être consultés dans le Système de suivi des Portages FreeBSD.
Certains portages en affectent un grand nombre d'autres du fait des dépendences et des relations portages-esclaves. Généralement, nous voulons que les personnes aient de l'expérience avant qu'ils maintiennent de tels portages.
Vous pouvez savoir si un portage a ou non des dépendences ou des portages esclaves en regardant un index maître de la collection des portages appelé INDEX (Le nom de ce fichier varie en fonction des distribution de FreeBSD; par exemple, INDEX-6). Certains portages ont des dépendences conditionnelles qui n'apparaissent pas dans la version par défaut de INDEX. Nous attendons de vous que vous soyez capable de reconnaître de tels portages en examinant les Makefiles d'autres portages.
Premièrement faites en sorte de comprendre vos responsabilités en tant que mainteneur. Lisez également le Guide du Porteur de logiciels. S'il-vous-plaît ne vous impliquez pas au delà de ce que vous pensez pouvoir raisonnablement assumer.
Vous pouvez demander à devenir mainteneur de n'importe quel portage non maintenu dès que vous le souhaitez. Assignez simplement votre propre adresse de courriel à MAINTAINER et envoyez un PR (Rapport de Problème) avec cette modification. Si le portage montre des erreurs lors de sa construction ou qu'il nécessite une mise à jour, vous devriez inclure tout autre changement dans le même PR. Ceci sera utile car beaucoup de committers sont moins enclins à assigner la maintenance à quelqu'un qui n'a pas d'antécédents connus avec FreeBSD. Soumettre des PRs qui corrigent des erreurs de construction ou mettent à jour des portages est le meilleur moyen de faire ses preuves.
Remplissez votre PR en indiquant la catégorie ports et la classe change-request. Un committer examinera votre PR, enregistrera vos modifications, et finallement fermera le PR. Parfois ce processus peut prendre du temps (les committers sont des volontaires eux aussi :).
Cette section vous donnera une idée de pourquoi les portages nécessitent qu'on les maintienne et met en évidence les résponsabilités qui incombent au mainteneur d'un portage.
Créer un portage est une tâche ponctuelle dans le temps. S'assurer qu'un portage est à jour, compile, et s'exécute toujours correctement nécessite un effort de maintenance continu. Les mainteneurs sont des personnes qui consacrent une partie de leur temps à atteindre ce but.
La raison principale pour laquelle les portages nécessitent une maintenance est d'apporter à la communinauté FreeBSD les tous derniers et meilleurs logiciels tiers disponibles. Un défi additionel est de s'assurer que les portages continuent à fonctionner au sein de la structure du dépôt des logiciels portés lorsque celle-ci évolue.
En tant que mainteneur, vous devrez relever les défis suivants :
Nouvelles versions et mises à jour logicielles. De nouvelles versions et mises à jour de logiciels portés apparaissent fréquemment, et il est nécessaire de les incorporer au dépôt des portages afin de proposer des logiciels qui soient à jour.
Changements dans les dépendences. Si des modifications significatives sont appliquées à des dépendences de votre portage, il pourrait être nécessaire de le mettre à jour pour qu'il continue à fonctionner correctement.
Changements affectant des portages dépendants. Si d'autres portages dépendent d'un portage dont vous avez la maintenance, appliquer des changements à votre portage pourrait nécessiter une coordination avec d'autres mainteneurs.
Interactions avec d'autres utilisateurs, mainteneurs et développeurs. Une des tâches du mainteneur est d'assurer un rôle de support. Vous n'êtes pas censé fournir un support d'ordre général (mais nous serions ravis si vous décidiez de le faire). Ce que vous devriez fournir, c'est un point de coordination pour les problèmes spécifiques à FreeBSD liés à vos portages.
Chasser les bogues. Un portage peut souffrir de bogues qui sont spécifiques à FreeBSD. Il vous faudra investiguer, trouver, et fixer ces bogues lorsqu'ils seront rapportés. Tester minutieusement un portage pour identifier les problèmes avant qu'ils ne fassent leur chemin dans le dépôt des logiciels portés est encore mieux.
Changements dans l'infrastructure des logiciels portés et politique. Occasionellement les systèmes qui sont utilisés pour construire les portages et les paquets binaires sont mis à jour ou bien de nouvelles recommendations affectant cette infrastructure sont établies. Vous devriez prendre connaissance de ces changements au cas où vos portages seraient affectés et nécessiteraient une mise à jour.
Changements dans le système de base. FreeBSD est en constant développement. Les changements de logiciels, librairies, du noyau, ou même des changements de politique peuvent induire des demandes de modifications sur les logiciels portés, et ce de manière continue.
Cette section expose la manière de procéder pour maintenir vos portages à jour.
Ceci est une vue d'ensemble. Des informations complémentaires sur la façon de mettre à jour un portage sont disponibles dans le Guide du Porteur d'applications.
Surveillez les mises à jour
Surveillez les sorties de nouvelles versions, mises à jour et correctifs de sécurité effectuées par l'éditeur du logiciel. Les listes diffusant les annonces ou les pages Web sont utiles pour cela. Parfois les utilisateurs vous contacteront et vous demanderont quand votre portage sera mis à jour. Si vous êtes occupé par d'autres tâches ou que vous n'êtes pas en mesure pour une raison ou une autre de le mettre à jour à ce moment, demandez-leur si ils peuvent vous aider en soumettant une mise à jour.
Il se peut que vous receviez également un courrier électronique de la part du Vérificateur de Version des Portages de FreeBSD vous informant qu'une version plus récente du fichier distribution pour votre portage est disponible. De plus amples informations à propos de ce système (incluant les instructions pour ne plus recevoir de notification) seront fournies dans les messages.
Intégrer les changements
Lorsqu'ils sont disponibles, intégrez les changements à votre portage. Vous devez être en mesure de pouvoir générer un patch entre le portage original et celui mis à jour.
Vérification et test
Vérifiez minutieusement et testez vos changements :
Compilez, installez et testez votre portage sur autant de plates-formes et d'architectures que vous pouvez. Il est courant pour un portage de fonctionner sur une branche ou une plate-forme et d'échouer sur une autre.
Faites en sorte qu'il ne manque aucune dépendance à votre portage. Il est recommendé pour cela d'installer votre propre tinderbox. Consultez les ressources pour plus d'informations.
Vérifiez que la liste des fichiers du paquetage est à jour. Cela implique de rajouter tout nouveau fichier ou répertoire et de supprimer toutes les entrées non utilisées.
Vérifiez votre portage en utilisant portlint(1) comme guide. Consultez les ressources pour obtenir des informations importantes sur la manière d'utiliser portlint.
Prenez en considération le fait que des changements sur votre portage pourraient casser d'autres portages. Si tel est le cas, coordonnez les modifications avec les mainteneurs de ces autres portages. Ceci est d'autant plus important que votre mise à jour modifie une version de librairie partagée, dans ce cas les portages dépendants auront au moins besoin d'une incrémentation de PORTREVISION pour qu'ils soient automatiquement mis à jour par des outils d'automatisation comme portupgrade(1).
Soumettre les changements
Envoyez votre mise à jour en soumettant un PR contenant les raisons de vos changements ainsi que le patch contenant les différences entre le portage original et celui mis à jour. Référez-vous à Ecrire des rapports de problème FreeBSD pour obtenir des informations concernant la manière d'écrire un bon PR.
Note : S'il-vous-plaît, ne soumettez pas une archive shar(1) du portage entier mais utilisez à la place diff(1) -ruN. De cette manière, les committers pourront bien plus facilement voir exactement les changements qui ont été faits. La section du Guide du Porteur d'applications sur la Mise à jour contient de plus amples informations à ce sujet.
Soyez patient
À un moment donné un committer s'occupera de votre PR. Cela peut prendre quelque minutes, ou quelques semaines - donc s'il-vous-plaît, soyez patient.
Faites-nous un retour
Si un committer détècte un problème avec vos changements, il vous le mentionnera très probablement. Une réponse rapide de votre part aidera à ce que votre PR soit pris en compte plus rapidement, et cela est mieux pour maintenir le fil de la discussion lorsque l'on essaie de résoudre un problème.
Et Finalement
Vos changements seront enregistrés et votre portage aura été mis à jour. Le PR sera alors fermé par le committer. Et voilà!
Cette section concerne la découverte et la correction de problèmes qui empêchent vos portages de compiler correctement.
FreeBSD garantit seulement que la collection des logiciels portés fonctionne sur la branche -STABLE. Vous devriez utiliser 5-STABLE ou 6-STABLE, préférablement cette dernière. Théoriquement vous devriez être capable de vous en sortir en faisant tourner la dernière version de chacune des branches stables (car les ABI ne sont pas supposées changer) mais si vous pouvez utiliser la branche c'est encore mieux.
Etant donné que la majorité des installations de FreeBSD tourne sur des machines compatibles PC (ce que l'on appelle l'architecture i386), nous attendons de vous que vous assuriez le bon fonctionnement du portage sur cette architecture. Cependant, comme de plus en plus de personnes commencent à utiliser l'architecture amd64 en natif, il va devenir de plus en plus important de s'assurer que les portages fonctionnent sur celle-ci aussi. Il est parfaitement acceptable de demander de l'aide si vous n'êtes pas en possession d'une telle machine.
Note : Les causes de disfonctionnement les plus courants sur les architectures non-i386 proviennent du fait que les programmeurs sont partis du principe que, par exemple, les pointeurs sont des ints, ou que le compilateur relativement laxiste gcc 2.95 a été utilisé. De plus en plus, les auteurs d'applications retravaillent leur code pour supprimer ce genre d'hypothèses -- mais si l'auteur ne maintient pas activement son code, il se pourrait que vous ayez à le faire vous-même.
Voici les tâches dont vous devez vous acquitter pour vous assurer que votre portage peut être construit :
Surveillez les erreurs de compilation
Vérifiez régulièrement les fermes de construction automatique des portages, pointyhat, ainsi que le scanneur des fichiers distribution pour voir si un des portages que vous maintenez ne parvient pas à compiler ou ne peut télécharger l'archive dont il a besoin (voir ressources pour plus d'informations concernant ces systèmes). Des rapports d'erreurs peuvent également vous parvenir par courrier éléctronique en provenance d'autres utilisateurs ou systèmes automatisés.
Collectez les informations
Lorsque vous avez détecté un problème, collectez les informations vous permettant de le corriger. Les erreurs de compilation rapportées par pointyhat s'accompagnent de fichiers d'historique qui vous montreront l'endroit où l'erreur de compilation est survenue. Si le problème vous a été rapporté par un utilisateur, demandez-lui de vous envoyer les informations qui vous aideraient à diagnostiquer le problème, comme :
Les fichiers d'historique de compilation
Les commandes et options utilisées pour construire le portage (incluant le jeu d'options présent dans /etc/make.conf)
La liste des paquets installés sur leur système tel qu'indiqué par pkg_info(1)
La version de FreeBSD qu'ils utilisent tel qu'indiqué par uname(1) -a
De quand date la dernière mise à jour de leur collection de logiciels portés
De quand date la dernière mise à jour de leur fichier INDEX
Investiguez et trouvez une solution
Malheureusement il n'existe pas de processus simple pour cela mais souvenez-vous cependant que si vous êtes bloqué, demandez de l'aide ! La liste de diffusion à propos du catalogue des logiciels portés de FreeBSD est un bon point de départ, et les développeurs en amont sont souvent très serviables.
Soumettre les changements
De la même manière que pour mettre à jour un portage, vous devriez inclure les changements, vérifier et tester, soumettre vos modifications dans un PR, et expliciter vos actions si besoin.
Envoyez vos modifications aux auteurs
Dans certains cas, il vous sera nécessaire de produire un correctif au portage pour qu'il fonctionne sur FreeBSD. Certains auteurs (mais pas tous) accepteront d'inclure de tels correctifs dans leur code pour la prochaine version. Dans ce cas, cela pourrait même être utile aux utilisateurs d'autres systèmes basés sur BSD et peut-être éviter des efforts redondants. Par courtoisie, prenez s'il-vous-plaît en considération l'envoi de vos correctifs aux auteurs du logiciel.
Cette section concerne la découverte et la correction des bogues.
Les bogues spécifiques à FreeBSD proviennent générallement d'hypothèses faites sur les environnements de compilation et d'exécution qui ne s'appliquent pas à FreeBSD. Il est moins probable que vous rencontriez un problème de ce type, mais il se peut qu'il soit plus subtile et difficile à diagnostiquer.
Voici les tâches que vous devrez effectuer pour vous assurer que votre portage continue à fonctionner comme attendu :
Répondre aux rapports de bogues
Les bogues peuvent vous être rapportés par courrier électronique par l'intermediaire de la base de données des rapports de problème GNATS. Les bogues peuvent également vous être rapportés directement par les utilisateurs.
Vous devriez répondre aux PRs et autres rapports dans les 14 jours, mais s'il-vous-plaît faites votre possible pour ne pas prendre autant de temps pour répondre. Essayez de le faire aussi vite que possible, même si c'est juste pour dire que vous avez besoin d'un peu de temps avant de pouvoir travailler sur ce PR.
Collectez les informations
Si la personne rapportant le bogue n'a pas dans le même temps fourni de correctif, vous devez collecter les informations nécessaires qui vous permettront d'en produire un.
Si le bogue est reproductible, vous pouvez collecter la plupart des informations nécessaires vous-même. Dans le cas contraire, demandez à la personne qui vous a rapporté le bogue de collecter les informations pour vous, comme :
Une description détaillée de leurs actions, le comportement attendu du programme ainsi que le comportement observé
Une copie des données d'entrée qui ont déclenché l'apparition du bogue
Les informations concernant leur environnement de compilation et d'exécution - par exemple, la liste des paquets installés et la sortie de env(1)
Images mémoire (Core dumps)
Traces de la pile mémoire (Stack traces)
Eliminez les rapports incorrects
Certains rapports de bogues peuvent être incorrects. Par exemple, l'utilisateur peut tout simplement avoir mal utilisé le programme; ou bien les paquets qu'ils ont installés peuvent être obsolètes et necessiter une mise à jour. Parfois un rapport de bogue n'est pas spécifique à FreeBSD. Rapportez dans ce cas le bogue aux développeurs en amont. Si vous avez les compétences requises pour résoudre le bogue, vous pouvez également corriger le portage de sorte que le correctif soit appliqué avant la diffusion par les développeurs de la version suivante du logiciel.
Trouvez une solution
Tout comme pour les erreurs de compilation, vous devrez trouver une solution au problème. À nouveau, souvenez-vous que vous pouvez demander de l'aide si vous êtes bloqué !
Soumettez ou approuvez les changements
Comme pour la mise à jour d'un portage, vous devriez intégrer vos changements, vérifier et tester, et soumettre vos modifications dans un PR (ou envoyer un suivi si un PR existe déjà pour ce problème). Si un autre utilisateur a soumis des changements dans le PR, vous pouvez également envoyer un suivi indiquant si vous approuvez ou non ces changements.
Fournir du support fait partie des tâches incombant au mainteneur -- pas pour le logiciel lui-même -- mais pour son portage ainsi que tout problème lié à FreeBSD. Les utilisateurs peuvent prendre contact avec vous concernant des questions, suggestions, problèmes ou correctifs. La plupart du temps leur correspondance sera spécifique à FreeBSD.
Occasionnellement vous devrez faire appel à vos talents diplomatiques, et aimablement orienter les utilisateurs à la recherche de support général vers les ressources appropriées. Moins fréquemment vous rencontrerez une personne demandant pourquoi les RPMs ne sont pas à jour ou comment il peut faire pour faire fonctionner le logiciel sous Linux Untel. Profitez de l'occasion pour lui dire que votre portage est à jour (si il l'est, bien évidemment !), et suggérez-lui d'essayer FreeBSD.
Parfois les utilisateurs et développeurs considéreront que vous êtes une personne occupée dont le temps est précieux et ils prendront en charge une partie de votre travail. Ils pourraient par exemple :
soumettre un PR ou envoyer un correctif pour mettre à jour votre portage,
investiguer et peut-être proposer un correctif à un PR, ou bien
proposer une modification à appliquer à votre portage.
Pour ce genre de situations votre principale obligation est de répondre rapidement. Le délai maximum qu'a un mainteneur pour répondre est de 14 jours. Après cette période les changements peuvent être appliqués même sans accord. Les utilisateurs ont pris la peine de faire le travail pour vous donc s'il-vous-plaît essayez de leur répondre rapidement. Puis vérifiez, approuvez, modifiez ou discutez leurs changements avec eux dès que possible.
Si vous parvenez à leur faire sentir que leur contribution est appréciée (cela devrait être le cas) vous serez plus en mesure de les persuader de faire plus de choses pour vous à l'avenir :-).
Il existe deux endroits vraiment appropriés pour trouver un portage qui requière de l'attention.
Vous pouvez utiliser l'interface Web vers la base de données des rapports de problèmes pour rechercher et consulter les PRs non résolus. La majorité des PRs relatifs aux logiciels portés sont des mises à jour, mais en recherchant un peu et en parcourant les résumés vous devriez être capable de trouver quelque chose d'intéressant sur lequel travailler (la catégorie sw-bug est un endroit approprié pour commencer).
L'autre endroit approprié est le Système de suivi des Portages FreeBSD. Recherchez en particulier les portages non maintenus qui présentent des erreurs de compilation et les portages qui sont marqués BROKEN (cassé). Il est aussi acceptable d'envoyer des changements pour un portage qui est maintenu, mais rappelez-vous de prévenir le mainteneur au cas où il serait déjà en train de travailler sur le problème.
Dès lors que vous avez trouvé un bogue ou problème, collectez les informations, investiguez et corrigez ! Si il existe déjà un PR, envoyez un suivi. Sinon créez un nouveau PR. Vos changements seront vérifiés et, si tout paraît correct, enregistrés.
Vos intérêts et vos engagements évoluant, il se peut que vous vous rendiez compte que vous n'avez plus le temps de continuer à contribuer à vos portages. Aucun soucis ! Faites-le nous savoir si vous n'utilisez plus un portage ou que vous n'avez plus le temps ou perdu l'intérêt d'être mainteneur. De la sorte nous pouvons prendre les mesures nécessaires et permettre à d'autres personnes d'essayer de travailler sur des problèmes concernant le portage sans attendre votre réponse. N'oubliez-pas, FreeBSD est un projet de volontaires, donc si maintenir un portage n'est plus amusant alors c'est probablement le bon moment pour laisser à quelqu'un d'autre le soin de s'en occuper !
En tous les cas, l'Equipe de Gestion des Logiciels Portés (portmgr) se réserve le droit d'annuler votre droit de mainteneur si vous n'avez pas activement maintenu votre portage pendant un certain temps (actuellement, cette période est de 3 mois). Par là nous voulons dire qu'il y a eu des problèmes non résolus ou des mises à jour en attente qui n'ont pas été traitées pendant cette période.
Le Guide du Porteur est votre guide du routard pour le système des portages. Gardez-le à porté de main !
Ecrire des rapports de problème pour FreeBSD décrit quelle est la meilleure manière de rédiger et soumettre un PR. En 2005 plus de onze mille PRs pour les portages ont été soumis ! Réspécter les consignes de cet article nous aidera grandement à réduire le temps temps nécessaire pour traiter vos PRs.
La Base de Données des rapports de problèmes.
Pointyhat (chapeau pointu) est la ferme de construction des portages. Vous pouvez utiliser Pointyhat pour vérifier les historiques de construction des portages pour toutes les architectures et versions majeurs.
Le Système de Surveillance des Portages FreeBSD peut vous montrer des informations croisées concernant les portages comme les erreurs de compilation et les rapports de problème. Si vous êtes un mainteneur vous pouvez l'utiliser pour vérifier le status de vos portages. En tant que contributeur vous pouvez l'utiliser pour trouver des portages défectueux ou non maintenus qui ont besoin d'un correctif.
Le scanneur des fichiers distribution des Portages FreeBSD peut vous montrer les portages pour lesquels le fichier distribution n'est pas téléchargeable. Vous pouvez vérifier vos propres portages ou bien trouver des portages pour lesquels leur MASTER_SITES a besoin d'une mise à jour.
Utiliser tinderbox est le moyen le plus rigoureux pour tester un portage sur tout le cycle d'installation, empaquetage, et désinstallation. Il présente une interface en ligne de commande mais peut aussi être contrôlé par l'intermédiaire d'une interface Web. Référez-vous à ports/ports-mgmt/tinderbox. Plus de documentation peut être trouvée à la page principale de tinderbox de marcuscom.
portlint(1) est une application qui peut être utilisée pour vérifier que votre portage est en conformité avec une multitude de recommendations stylistiques et fonctionnelles. portlint est une application simple basée sur des heuristiques, donc vous devriez l'utiliser seulement à titre indicatif. Si portlint vous suggère des modifications qui ne vous semblent pas appropriées, consultez le Guide du Porteur ou demandez conseil.
La liste de diffusion à propos du catalogue des logiciels portés de FreeBSD convient pour les discussions générales sur les portages. C'est un bon endroit pour demander de l'aide. Vous pouvez souscrire, ou lire et rechercher dans les archives de la liste. Lire les archives de la liste de diffusion à propos des rapports de bogue concernant le catalogue des logiciels portés de FreeBSD et de la liste de diffusion des messages de modification CVS concernant les logiciels portés de FreeBSD peut aussi présenter de l'intérêt.
Ce document, ainsi que d'autres peut être téléchargé sur ftp.FreeBSD.org/pub/FreeBSD/doc/.
Pour toutes questions à propos de FreeBSD, lisez la documentation avant de contacter <questions@FreeBSD.org>.
Pour les questions sur cette documentation, contactez <doc@FreeBSD.org>.