Les deux révisions précédentesRévision précédenteProchaine révision | Révision précédente |
1_generalites:programmation:faire_un_rapport_de_bug [2021/03/15 20:28] – Mise à jour de la page suite au déplacement des pages. yannick.tanguy | 2_programmation:faire_un_rapport_de_bug [2022/09/22 14:07] (Version actuelle) – Insertion d'espace de longueur nulle en vue de conversion dbitouze |
---|
====== Que faire si vous trouvez un bug ? ====== | ====== Que faire si vous trouvez un bug? ====== |
| |
Pour commencer, vérifiez que vous avez //vraiment// trouvé un bug : | Pour commencer, vérifiez que vous avez //vraiment// trouvé un bug : |
**Les raisons de cette prudence sont nombreuses.** | **Les raisons de cette prudence sont nombreuses.** |
| |
Si vous avez trouvé un bug dans <latex>\TeX</latex> 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 [[https://www-cs-faculty.stanford.edu/~knuth/abcde.html|offre de l'argent]] aux découvreurs de bug ; les chèques qu'il rédige sont si rares qu'ils ne sont quasiment [[https://en.wikipedia.org/wiki/Knuth_reward_check|jamais encaissés]]. Si //vous// pensez que vous avez réellement trouvé une erreur dans <latex>\TeX</latex> (ou MetaFont ou les fontes Computer Modern ou le <latex>\TeX</latex> 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@freefriends.org|Karl Berry]] du [[1_generalites:glossaire:que_sont_les_groupes_d_utilisateurs|TUG]] (en anglais). | Si vous avez trouvé un bug dans <latex>\TeX</latex> 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 [[https://www-cs-faculty.stanford.edu/~knuth/abcde.html|offre de l'argent]] aux découvreurs de bug ; les chèques qu'il rédige sont si rares qu'ils ne sont quasiment [[https://en.wikipedia.org/wiki/Knuth_reward_check|jamais encaissés]]. Si //vous// pensez que vous avez réellement trouvé une erreur dans <latex>\TeX</latex> (ou MetaFont ou les fontes Computer Modern ou le <latex>\TeX</latex>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@freefriends.org|Karl Berry]] du [[1_generalites:gutenberg|TUG]] (en anglais). |
| |
Si vous avez trouvé un bug dans <latex>\LaTeXe</latex>, **déclarez-le** (voir ci-dessous) en utilisant les mécanismes mis en place par l'équipe <latex>\LaTeX</latex>. Soyez bien attentif à vous assurer qu'il s'agit d'un bug de <latex>\LaTeX</latex> ou d'une des extensions distribuées par l'équipe <latex>\LaTeX</latex>. | Si vous avez trouvé un bug dans <latex>\LaTeXe</latex>, **déclarez-le** (voir ci-dessous) en utilisant les mécanismes mis en place par l'équipe <latex>\LaTeX</latex>. Soyez bien attentif à vous assurer qu'il s'agit d'un bug de <latex>\LaTeX</latex> ou d'une des extensions distribuées par l'équipe <latex>\LaTeX</latex>. |
Si vous avez trouvé un bug dans <latex>\LaTeX</latex> 2.09 ou dans un des autres logiciels qui ne sont plus maintenus, votre seul espoir est [[1_generalites:documentation:listes_de_discussion|l'aide en ligne]]. | Si vous avez trouvé un bug dans <latex>\LaTeX</latex> 2.09 ou dans un des autres logiciels qui ne sont plus maintenus, votre seul espoir est [[1_generalites:documentation:listes_de_discussion|l'aide en ligne]]. |
| |
Si tout ceci échoue, envisagez de payer pour obtenir de l'aide : le [[1_generalites:glossaire:que_sont_les_groupes_d_utilisateurs|TUG]] tient à jour un [[http://www.tug.org/consultants.html|registre]] de consultants <latex>\TeX</latex>. Ceci suppose que vous avez les ressources et un besoin tel que vous puissiez recruter quelqu'un. | Si tout ceci échoue, envisagez de payer pour obtenir de l'aide : le [[1_generalites:gutenberg|TUG]] tient à jour un [[http://www.tug.org/consultants.html|registre]] de consultants <latex>\TeX</latex>. Ceci suppose que vous avez les ressources et un besoin tel que vous puissiez recruter quelqu'un. |
| |
| |
===== Comment déclarer un bug LaTeX ? ===== | ===== Comment savoir si un bug vient de LaTeX ou d'une extension ? ===== |
| |
L'équipe <latex>\LaTeX</latex> fait la maintenance de <latex>\LaTeX</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>\LaTeX</latex>, à savoir <latex>\LaTeX</latex> et les seules extensions qui lui sont « indispensables ». | L'équipe <latex>\LaTeX</latex> fait la maintenance de <latex>\LaTeX</latex> et traite tout rapport de bug. |
| Mais elle //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>\LaTeX</latex>, à savoir <latex>\LaTeX</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 : | Si le bug que vous avez trouvé est dans une extension maintenue par d'autres développeurs, c'est à eux que vous devez |
| faire votre rapport. |
| |
| Pour vous aidez à savoir à qui déclarer le bug, l'équipe de développement de LaTeX fournit l'extension [[ctanpkg>latexbug]]. |
| Vous devez vous en servir pendant que vous composez l'exemple qui illustrera votre rapport de bug. |
| Pour cela, il suffit d'ajouter la ligne ''\RequirePackage{latexbug}'' en tout début de fichier: |
| |
| <code latex> |
| \RequirePackage{latexbug} % Première ligne obligatoire |
| |
| \documentclass{article} % Ensuite, votre exemple |
| ... % de code qui illustre le bug |
| \end{document} |
| </code> |
| |
| Pendant la compilation, sur le terminal, vous verrez des indications à propos des extensions chargées, |
| qui les maintient, et où vous devez envoyer votre rapport de bug: |
| |
| <code text> |
| Package latexbug Error: Third-party file(s) |
| (latexbug) |
| (latexbug) This test file uses third-party file(s) |
| (latexbug) |
| [...] |
| [... Liste des extensions et de leurs mainteneurs ...] |
| [...] |
| (latexbug) So you should contact the authors |
| (latexbug) of these files, not the LaTeX Team! |
| (latexbug) (Or remove the packages that load |
| (latexbug) them, if they are not necessary to |
| (latexbug) exhibit the problem). |
| </code> |
| |
| Si vous pensez que l'une ou l'autre des extensions indiquées n'est pas à l'origine du bug, |
| adaptez votre exemple pour les retirer. Ceci vous permettra de réduire votre exemple |
| pour former un [[1_generalites:documentation:listes_de_discussion:comment_faire_un_exemple_complet_minimal|ECM]], |
| et de cerner l'origine du bug, ce qui aidera les mainteneurs à vous aider. |
| |
| |
| ===== Comment déclarer un bug de LaTeX ? ===== |
| |
| Dans tous les cas, vous devez bien faire attention à produire un rapport de bug qui soit utilisable par l'équipe. |
| Voici les étapes à suivre : |
| |
- Utilisez-vous une version récente de <latex>\LaTeX</latex> ? La maintenance n'est possible que sur des versions suffisamment à jour de <latex>\LaTeX</latex>. | - Utilisez-vous une version récente de <latex>\LaTeX</latex> ? La maintenance n'est possible que sur des versions suffisamment à jour de <latex>\LaTeX</latex>. |
- Compilez votre fichier de test avec <latex>\LaTeX</latex> : le rapport de bug doit inclure le fichier ''.log'' créé par la compilation. | - Compilez votre fichier de test avec <latex>\LaTeX</latex> : le rapport de bug doit inclure le fichier ''.log'' créé par la compilation. |
- Enfin, [[https://github.com/latex3/latex2e/issues/new|déclarez l'incident]] dans la [[https://github.com/latex3/latex2e/issues|base d'anomalies]] <latex>\LaTeX</latex> . | - Enfin, [[https://github.com/latex3/latex2e/issues/new|déclarez l'incident]] dans la [[https://github.com/latex3/latex2e/issues|base d'anomalies]] <latex>\LaTeX</latex> . |
| |
| |
| |
//Sources:// | //Sources:// |
* [[faquk>FAQ-bug|What to do if you find a bug]], | * [[faquk>FAQ-bug|What to do if you find a bug]], |
* [[faquk>FAQ-latexbug|Reporting a LaTeX bug]]. | * [[faquk>FAQ-latexbug|Reporting a LaTeX bug]], |
| * [[https://www.texdev.net/2017/12/16/latex2e-kernel-development-moves-to-github/|LaTeX2e kernel development moves to GitHub]], sur le blog de Joseph Wright. |
| |
{{htmlmetatags>metatag-keywords=(LaTeX,problème,bug,débogage,rapport de bug,bugs dans TeX,bogues dans TeX,bugs dans LaTeX) | {{htmlmetatags>metatag-keywords=(LaTeX,problème,bug,débogage,rapport de bug,bugs dans TeX,bogues dans TeX,bugs dans LaTeX) |