• Objet : Utiliser reportbug pour signaler un bogue à la communauté Debian
• Niveau requis :

  avisé

  , savoir lire et écrire en Anglais.

• Commentaires :
• Débutant, à savoir : Utiliser GNU/Linux en ligne de commande, tout commence là !.
• Suivi :

  en-chantier, à-tester, à-placer

  - Pour choisir, voir les autres Tags possibles dans l'Atelier.

  • Création par Kao 24/10/2014
  • Testé par <…> le <…>
• Commentaires sur le forum : Lien vers le forum concernant ce tuto ¹⁾

Reportbug est une application proposée par l'équipe Debian pour signaler des bogues aux mainteneurs des paquets. Afin que le bogue soit résolu, et que le rapport soit utile, il faut être précis, fournir le maximun d'information et être prêt à aider le mainteneur. Tout cela pour faciliter le traitement de votre bogue et trouver un solution le plus rapidement possible.

Avant toute chose, il faut savoir reproduire le bogue afin de bien l'identifier.

• Il faut essayer de le reproduire sur différente machine, pour voir si des indices communs ressortent, exemple: Ce bug n'est présent que sur les machines ayant un noyau 3.16.
• Il faut essayer de bien identifier le mode opératoire, exemple: Je clique huit fois rapidement sur l'icône puis j'appuie une fois sur la touche espace et l'application gèle.
• 

Les applications Open Source communiquent beaucoup sous forme de petit message, surtout quand elles rencontrent des erreurs. Il est possible de voir ces messages en lançant l'application en ligne de commande dans un terminal.

vlc

Certaines applications disposent souvent d'un mode plus verbeux, où l'on pourra voir plus de message.

vlc -v

Il est aussi possible de diriger les messages d'erreurs de l'application dans un fichier texte afin d'en garder une trace:

vlc -v 2> log.txt

Les applications systèmes travaillent le plus souvent en fond de tâche, il faudra passer par les fichiers journaux pour consulter leurs messages. Ils se présentent, le plus souvent, sous forme texte dans le dossier /var/log. On peut voir les fichiers se remplir en temps réél avec la commande tail -f, cela peut être utile:

tail -f /var/log/messages

Si dans le message d'erreur, on a la mention d'une erreur à propos d'un fichier, on peut identifier à quel paquet il appartient avec la commande dpkg -S.

dpkg -S /usr/share/vlc/utils/audio-vlc-default.sh

vlc-data: /usr/share/vlc/utils/audio-vlc-default.sh

Le fichier qui pose problème est donc lié au paquet vlc-data et non au paquet vlc. La nuance permettra d'affecter la fiche boque au bon paquet.

Toujours, avant de se lancer dans l'ouverture d'un nouveau bug, il est bon de vérifier qu'il n'a pas déjà été signalé ou qu'il n'est pas déjà résolu. Il est donc important d'avoir une machine à jour et de vérifier que l'on a bien la dernière version du paquet disponible. On peut voir les différentes versions du paquet disponible dans l'encart “Versions” du tracker Debian, comme ici pour VLC: https://tracker.debian.org/pkg/vlc

Que l'on peut comparer avec celle que l'on a d'installé sur sa machine:

apt-cache policy vlc

Avant de créer le bogue, l'application reportbug devrait vous montrer les bogues existant. Vous pouvez aussi les consulter en ligne pour chaque application. Ils sont accessible depuis l'encart “Bugs” du tracker debian: https://tracker.debian.org/pkg/vlc

Avant de se lancer dans l'ouverture d'un bogue, il est important d'en parler sur le forum en remontant les informations que vous aurez récolté comme indiqué plus haut.

• On peut avoir manqué un détail.
• On peut avoir une confirmation du bogue par quelqu'un qui va réussir à le reproduire.
• On peut trouver de l'aide pour le rédiger dans la langue de Shakespeare.

Reportbug est l'application de référence pour déclarer un bug aux équipes Debian. Il est possible de déclarer un bogue par courriel directement, mais ce sera toujours plus propre, et plus complet en passant par reportbug.

Si ce n'est pas déjà fait, pour installer reportbug, il suffit de taper:

apt-get install reportbug

reportbug dispose de plusieurs mode, à besoin d'un adresse mail pour déclarer les bogues. Il est possible de configurer cela facilement avec:

reportbug --configure

Ou en éditant le fichier ~/.reportbugrc

Afin de lancer rapporter un bogue lié à un paquet, il suffit de lancer:

reportbug nom-de-mon-paquet

Une fois lancé, reportbug vous guidera à chaque étape:

• Il vérifiera le statut du paquet pour être sur que vous ayez bien la version la plus récente:

Getting status for glpi...
Checking for newer versions at madison...

• Il vous proposera la liste des bogues connus afin de ne pas créer de doublon:

Will send report to Debian (per lsb_release).
Querying Debian BTS for reports on glpi (source)...
8 bug reports found:
....

• Il proposera d'associer certaines valeurs de configuration au rapport:

Looking up dependencies of glpi...
Getting changed configuration files...

• Il demandera un titre de bogue le plus explicite possible (en Anglais)

Briefly describe the problem (max. 100 characters allowed). This will be the bug email subject, so keep the summary as concise as possible, for example:
"fails to send email" or "does not start with -q option specified" (enter Ctrl+c to exit reportbug without reporting a bug).

• Il vous demandera de choisir avec précaution un niveau de sévérité à associer au bogue:

How would you rate the severity of this problem or report?

1 critical        makes unrelated software on the system (or the whole system) break, or causes serious data loss, or introduces a security hole on systems
                  where you install the package.
2 grave           makes the package in question unusable by most or all users, or causes data loss, or introduces a security hole allowing access to the
                  accounts of users who use the package.
3 serious         is a severe violation of Debian policy (that is, the problem is a violation of a 'must' or 'required' directive); may or may not affect the
                  usability of the package. Note that non-severe policy violations may be 'normal,' 'minor,' or 'wishlist' bugs. (Package maintainers may
                  also designate other bugs as 'serious' and thus release-critical; however, end users should not do so.). For the canonical list of issues
                  worthing a serious severity you can refer to this webpage: http://release.debian.org/wheezy/rc_policy.txt .
4 important       a bug which has a major effect on the usability of a package, without rendering it completely unusable to everyone.
5 does-not-build  a bug that stops the package from being built from source. (This is a 'virtual severity'.)
6 normal          a bug that does not undermine the usability of the whole package; for example, a problem with a particular option or menu item.
7 minor           things like spelling mistakes and other minor cosmetic errors that do not affect the core functionality of the package.
8 wishlist        suggestions and requests for new features.

• Il sera possible de notifier plus précisément certains bogues afin de prévenir les équipes concernés:

Do any of the following apply to this report?

1 d-i       This bug is relevant to the development of debian-installer.
2 ipv6      This bug affects support for Internet Protocol version 6.
3 l10n      This bug reports a localization/internationalization issue.
4 lfs       This bug affects support for large files (over 2 gigabytes).
5 patch     You are including a patch to fix this problem.
6 upstream  This bug applies to the upstream part of the package.</quote>
7 none      

• En dernier lieu, avant d'envoyer le rapport, reportbug chargera le rapport dans un éditeur de texte afin de remplacer le passage entre “**” par une description précise, en Anglais, du problème que vous rencontrer.

• https://www.debian.org/Bugs/Reporting
• 7 astuces par Raphael Hertzog: ici