Signaler les bogues

Comme il est impossible pour nos développeurs de tester toutes les combinaisons de matériel, ni tous les cas de figure pouvant interagir avec le système d'exploitation, nous comptons sur les utilisateurs pour nous dire si les choses fonctionnent pour eux. puisque Haiku est encore tout jeune, il est très probable que vous rencontriez des bogues. Nous vous remercions de bien vouloir prendre le temps de nous les signaler. Ensemble, nous pourrons, petit à petit, améliorer Haiku.

Afin que le suivi de nos bogues reste efficace, il est essentiel de respecter l'étiquette de suivi des bogues.

Obtenir un compte Trac

Pour remplir un rapport (ticket), vous aurez besoin d’un compte utilisateur sur le Traqueur de bogues de Haiku.
Lors de la création d’un nouveau compte, pensez à indiquer votre adresse e-mail afin d’obtenir les privilèges basiques de gestions des tickets. N’oubliez pas de Vérifier votre dossier de pourriel après, car les e-mails de vérifications s’y retrouvent souvent.

Créer un rapport de bogue

Avant de rapporter un bogue, veuillez vérifier qu’il n’est pas déjà répertorié. Vous pouvez aussi utiliser la fonction de recherche pour cela.
Après vous être assuré que votre bogue est unique, obtenez des informations précises sur votre environnement :

Essayez de reproduire votre problème avec la version actuelle d'Haiku. Des images préfabriqués sont disponible à cet usage.
Indiquez comment vous testez Haiku (sur machine réelle, dans VMware, dans Qemu…)
Indiquez quelle révision SVN de Haiku vous utilisez. Vous pouvez trouver cette information dans le menu « About This System… » de la Deskbar. N'oubliez pas de mentionner de quel type de construction est issu le système Haiku que vous testez (gcc2, gcc4, gcc2hybrid, gcc4hybrid). Les images téléchargeables sont nommés en conséquence. Si vous avez construit l'image vous-même, vous devriez savoir comment vous l'avez compilé.
Décrivez le problème que vous rencontrez. soyez aussi précis que possible : décrivez le comportement réel, et celui que vous attendiez.
Décrivez les actions que vous avez effectuées avant de faire ressortir le bogue. Cela permettra aux développeurs de le reproduire.
Attachez au rapport le plus d’informations possibles. Si le bogue concerne l’interface graphique ou une application, essayez de faire une capture d’écran à l'aide de la la touche IMPR ÉCRAN.

Bogues logiciels

Lorsqu'une application se plante, vous devez appeler le débogueur depuis le message d'alerte qui s'affiche. Une fenêtre de Terminal devrait s'ouvrir avec gdb (le débogueur GNU) lancé à l'intérieur. En saisissant bt, vous obtiendrez ainsi une trace de la « pile d'appel » (backtrace) que vous devez joindre en intégralité (y compris la partie précédant l'appel à la commande bt) à votre rapport de bogue.

Bogues dans les serveurs

Lorsque les serveurs vitaux comme le serveur d'application, de registre ou d'entré plantent, vous ne verrez pas l'alerte de crash habituelle. à la place, l'écran sera nettoyé de blanc et une session gdb sera lancée, qui affichera directement ses restitutions à l'écran. Il se pourrait que vous soyez toujours à même de déplacer la souris, qui dessinera alors par dessus l'écran blanc de gdb. Les demandes encore en cours (comme ProcessController ou l'horloge dans la barre de Bureau) pourrait également dessiner au dessus de la sortie du débogueur à l'écran.
Bien que tout soit plus laid et peu commode, les même fondamentaux que pour déboguer les applications s'appliquent. Le plus important est de fournir une trace de la pile d'appel à l'aide de la commande bt (backtrace). Mais comme vous ne serez pas en mesure de copier le texte, vous aurez besoin de prendre une photo de l'écran avec un appareil photo numérique.

Bogues du noyau

Les bogues du noyau sont habituellement ceux qui ont les effets les plus graves, tout en étant les plus difficiles à déboguer. Il existe différents types de symptômes, qui révèlent généralement un problème du noyau ou d'un pilote :

Le système entre en mode débogage du noyau (KDL) de lui même. La partie supérieure de l'écran est mise à blanc et plusieurs lignes de texte sont affichées. La seconde ligne dit « Welcome to Kernel Debugging Land… ». Celle au-dessus, précise la raison qui a déclenchée la session de débogage du noyau (KDL).
Le système redémarre spontanément.
Le système se bloque complètement. Vous ne pouvez pas déplacer la souris et plus aucune application ne dessine quoi que se soit. Dans cette situation, un bon test consiste à essayer d'accéder au KDL via le raccourci ALT SysReq D (SysReq étant la touche Impr sur la plus part des claviers). Attendez au moins une minute, pour voir si quelque chose se passe.
Le système ne démarre pas correctement. Il peut redémarrer spontanément ou s'arrêter à un moment donné (par exemple au niveau d'une icône de l'écran de démarrage). Dans ce dernier cas vous pouvez essayer aussi ALT SysReq D.
L'ensemble du système ou un élément matériel ne se comporte pas correctement. Par exemple, il pourrait être très lent, des erreurs pourraient se produisent, ou quelque chose pourrait ne pas fonctionner du tous. Si un périphérique ne fonctionne pas du tout, la première vérification évidente à faire, est de se renseigner pour savoir si il est déjà supporté par Haiku (par exemple, en posant la question sur une liste de diffusion ou un forum).

Notez que si seul le dernier point semble indiquer une relation avec le matériel, tous les autres symptômes pourraient aussi être causés par un bogue dans un pilote. Si vous soupçonnez un matériel ou son pilote d'être responsable du problème, vérifiez si la suppression ou la désactivation du matériel ou du pilote change quelque chose. Par exemple, si vous soupçonnez le Wifi, votre BIOS a peut-être une option pour le désactiver. Sinon, vous pouvez supprimer le pilote Wifi installé dans Haiku (dans /boot/system/add-ons/kernel/drivers/bin).

Le mode débogage noyau - KDL

Si le système n'entre pas de lui même en mode déboguage du noyau (KDL) vous pouvez le faire volontairement en invoquant le raccourci clavier ALT Syst D Attention : l'ordre des touches compte (SYST correspond à Impr Écran sur la plupart des claviers). Notez bien que votre clavier pourrait ne pas fonctionner en mode déboguage du noyau. Alors que les claviers PS/2 ne posent pas de problème, les claviers USB connecté à un controleur UHCI ne fonctionne que si vous être entré au moins une fois en mode débogage à l'aide du raccourci clavier. Pour le moment l'USB OHCI n'est pas supporté.

KDL est, par lui-même, une sorte d'interpréteur de commande. On peut exécuter des instructions pour afficher des informations sur le système. Les commandes suivantes pourraient vous intéresser :

bt (alias sc)		Affiche une trace de débogage (backtrace), Faites systematiquement cette commande quand le système entre dans le débogueur de lui même.
ints		Affichera les interruptions matérielles qui sont gérées, ainsi que celles qui sont ignorées.
co (alias continue)		Quitte le débogueur pour reprendre, si possible, les opérations normales du système.
reboot		Redémarre le système immédiatement. Vous perdrez toutes les données non enregistrées, ainsi que celles qui ont été enregistrés, mais qui n'ont pas encore été écrites sur le disque.

Pour plus d'information, consultez l'article Welcome to Kernel Debugging Land.

La sortie KDL est écrite vers le port série ( si vous en avez un, un câble approprié, et un deuxième ordinateur pour vous connecter, vous pourrez capturer la sortie via un programme de terminal) et le journal système. Nottez que si vous ne pouvez pas sortir du mode de débogage du noyau, le journal ne sera pas écrit dans le fichier. Cependant, Il existe une option dans le menu de démarrage qui permet tout de même sa capture (voir ci-dessous).

Vous pouvez générer des codes QR à partir des sorties du KDL, ce qui vous permet de récupérer le texte en photographiant l'écran avec un un smartphones ou un appareil similaires. Consultez le blog QR Encode your KDL Output pour obtenir les informations sur l'utilisation de cette fonctionnalité dans le KDL.

Le journal système

C'est la méthode privilégiée pour obtenir des informations d'un système qui ne démarre pas.
Le journal système ( « syslog » en abgégé) contient des informations précieuses sur ce qui s'est passé dans votre système, y compris les productions des sessions KDL. L'attacher au ticket « kernel » dans l'outil de suivi de bogues (Trac) est généralement une bonne pratique. Le journal est consigné dans le fichier /boot/common/var/log/syslog.Puisque l'écriture d'un fichier requiert un système qui fonctionne, les écritures les plus récente faites dans le journal ne peuvent pas être présentes quand un problème se produit dans le noyau (en particulier lors d'un redémarrage spontané ou d'une sessions KDL non recouvrable).

L'option Enable debug syslog dans le menu Debug menu du chargeur de démarrage rend le journal légèrement persistant en mémoire. Cette option est activée par défaut. « légèrement persistant » signifie qu'il résistera à une réinitialisation et qu'il sera encore accessible quand vous entrerez dans le menu du chargeur de démarrage juste après. Noter qu'amorcer un système d'exploitation (Haiku sans aucun doute, et probablement les autres) détruit cette information. Alors vous devez rentrer dans le menu du chargeur de démarrage en maintenant la touche MAJ enfoncée pendant le redémarrage.
Dans le menu du chargeur de démarrage Debug menu, vous devriez maintenant trouver les entrés Display syslog from previous session et Save syslog from previous session. La première, affiche le journal de la session précédente à écran. La dernière vous permet de l'enregistrer dans un fichier sur disque. Notez que pour le moment seuls les volumes FAT32 sont pris en charge pour l'enregistrement du fichier. Si vous souhaitez utiliser une clé USB, mais que vous l'avez branchée trop tard de sorte qu'elle n'a pas été prise en compte, vous pouvez réinitialiser la machine et entrer à nouveau dans le menu du chargeur de démarrage. Mais encore une fois : Ne démarrer aucun système d'exploitation accidentellement ou les données seront perdues.

Les sorties écran du débogueur

La sortie écran du débogueur n'est utile que pour déboguer certains problèmes bien spécifiques, et est connu pour avoir des problèmes (timing). Ne l'utilisez que si vous en avez vraiment besoin.
Ce n'est pertinent que si Haiku n'arrive pas à démarrer sur votre machine et que le Debug syslog option ne fonctionne pas pour quelque raison que ce soit. Pour accéder au menu du chargeur de démarrage, maintenez la touche MAJ enfoncée avant que le logo de Haiku n'apparaisse. Choisissez Select safe mode options. Selectionnez [ ] Enable on screen debug output que vous verrez en bas. (Notez que les autres options peuvent êtres activées pour tenter de démarrer Haiku. Si Haiku ne démarre que lorsque certaines options sont activées, n'oubliez pas de mentionner lesquelles )
Enfin choisissez Return to main menu puis Continue booting.
Une ou plusieurs pages de texte seront affiché à l'écran, Seules les quelques dernières lignes ont besoin de figurer dans votre rapport de bogue. Vous trouvez plus d'information dans le sujet consacré au Chargeur de démarrage.

Bogues liés au matériel ou aux pilotes

Lorsque le bogue concerne un matériel ou son pilote, veuillez attacher au rapport, un fichier texte contenant les renseignements suivants :

- listdev		Fait une liste détaillée de votre matériel, en y incluant les identifiants des périphériques PCI et de leurs fabriquants, à la manière de lshw ou lspci dans GNU/Linux.
- listusb -v		Fait comme lsusb en supposant que c'est un problème lié à l'USB.
- open /var/log/syslog		Le journal système principal utilisé par Haiku, semblable à celui de l'écran de débogage pendant le démarrage. Avec la commande open, vous pouvez modifier ce journal dans un éditeur de texte pour n'en conserver que la partie la plus pertinente.
- listimage \| grep drivers/		Liste tous les drivers utilisés.
- ints		Seulement disponible dans le mode débogage du noyau (voir ci-dessous). Montre l'utilisation des interruptions. Il ne devrait pas y avoir trop d'interruptions partagées par plusieurs périphériques.
- Les sorties écran du débogueur (une option de mode sans échec du démarrage).

Les 4 premières commandes sont à exécuter dans le Terminal. Si vous ajoutez > sortie.txt après une commande, sa sortie sera redirigée dans un fichier texte nommé « sortie.txt » que vous pourrez attachez à votre rapport de bogue ou e-mail.

Et après ?

Une fois le bogue rapporté, un développeur le consultera et essayera de le cataloguer. Retenez que tous les développeurs sont des volontaires; un long délai avant réponse peut s’écouler après le rapport de bogue. L’ajout de nouvelles informations une fois celles-ci disponibles peut généralement permettre à un bogue d’être analysé plus rapidement. Néanmoins, n’essayez pas de « faire remonter » un bogue en ajoutant des commentaires non pertinents.

N’oubliez pas, le rapport d’un bogue ne se limite pas à sa soumission. Une fois cette tâche faite, vous ferez partie du processus de développement de Haiku. Les développeurs pourront vous poser des question pour essayer de résoudre votre bogue. Merci de rester disponible pour y répondre. Vous pourrez considérer votre travail « terminé » quand le bogue sera marqué comme étant « corrigé ».