Que faire si vous trouvez un bug?

Pour commencer, vérifiez que vous avez vraiment trouvé un bug :

  • regardez bien dans des livres traitant de \TeX, \LaTeX ou tout autre variante que vous utilisez ;
  • comparez ce que vous observez avec les réponses de cette FAQ ;
  • demandez aux personnes que vous connaissez et qui ont une expertise en lien avec \TeX.

Les raisons de cette prudence sont nombreuses.

Si vous avez trouvé un bug dans \TeX lui-même, vous appartenez en effet à une espèce fort rare. Donald Knuth est tellement sûr de la qualité de son code qu'il offre de l'argent aux découvreurs de bug ; les chèques qu'il rédige sont si rares qu'ils ne sont quasiment jamais encaissés. Si vous pensez que vous avez réellement trouvé une erreur dans \TeX (ou MetaFont ou les fontes Computer Modern ou le \TeX book), n'écrivez pas immédiatement à Knuth. Il analyse les bugs de façon assez sporadique, même si ces derniers ont été validés par une petite équipe d'experts. Dans un premier temps, contactez Karl Berry du TUG (en anglais).

Si vous avez trouvé un bug dans \LaTeXe, déclarez-le (voir ci-dessous) en utilisant les mécanismes mis en place par l'équipe \LaTeX. Soyez bien attentif à vous assurer qu'il s'agit d'un bug de \LaTeX ou d'une des extensions distribuées par l'équipe \LaTeX.

Si vous avez trouvé un bug dans une extension, le mieux est de commencer par les lieux usuels pour obtenir de l'aide en ligne ou les différentes listes de diffusion spécialisées. L'auteur de l'extension pourrait bien vous répondre en ligne mais, si personne d'autre ne vous fournit d'aide, vous pouvez tenter de lui écrire directement (en supposant que vous arrivez à trouver son adresse).

Si vous avez trouvé un bug dans \LaTeX 2.09 ou dans un des autres logiciels qui ne sont plus maintenus, votre seul espoir est l'aide en ligne.

Si tout ceci échoue, envisagez de payer pour obtenir de l'aide : le TUG tient à jour un registre de consultants \TeX. Ceci suppose que vous avez les ressources et un besoin tel que vous puissiez recruter quelqu'un.

Comment déclarer un bug LaTeX ?

L'équipe \LaTeX fait la maintenance de \LaTeX et traite tout rapport de bug. Notez que l'équipe ne traite pas les bugs des multiples extensions dont elle n'est pas l'auteur : elle ne suit que les logiciels qui font partie de la distribution \LaTeX, à savoir \LaTeX et les seules extensions qui lui sont « indispensables ».

De plus, vous devez bien faire attention à produire un rapport de bug qui soit utilisable par l'équipe. Voici les étapes à suivre :

  1. Utilisez-vous une version récente de \LaTeX ? La maintenance n'est possible que sur des versions suffisamment à jour de \LaTeX.
  2. Votre bug a-t-il déjà été rapporté ? Parcourez l'actuelle base d'anomalies \LaTeX et l'ancienne base GNATS \LaTeX pour trouver un éventuel rapport antérieur de votre bug. Dans de nombreux cas, ces bases listeront des solutions de contournement.
  3. Préparez un exemple minimal qui présente le problème. Idéalement, ce fichier ne doit contenir que des extensions « indispensables » suivies par l'équipe \LaTeX car les autres extensions font l'objet de suivis par leurs propres auteurs. L'exemple minimal doit être auto-suffisant : si un membre de l'équipe le compile dans un répertoire propre avec un système n'ayant que les extensions « indispensables », l'anomalie doit se produire. Vous pouvez consulter les conseils de l'équipe \LaTeX pour plus de détails.
  4. Compilez votre fichier de test avec \LaTeX : le rapport de bug doit inclure le fichier .log créé par la compilation.

Sources:

2_programmation/faire_un_rapport_de_bug.txt · Dernière modification: 2021/03/15 21:28 par yannick.tanguy
CC Attribution-Share Alike 4.0 International
Driven by DokuWiki Recent changes RSS feed Valid CSS Valid XHTML 1.0