Een probleem in Debian rapporteren met reportbug

We raden sterk aan om problemen (bugs) in Debian te rapporteren met behulp van het programma reportbug. De commando's om reportbug te installeren en starten zijn eenvoudig:

aptitude install reportbug; reportbug

Het programma zal u stap voor stap door het proces van het rapporteren van een probleem begeleiden.

Als u vragen heeft die de interactieve prompts van reportbug niet oplossen, dan kunt u de verdere documentatie hieronder raadplegen of om hulp vragen op de mailinglijst voor gebruikers van Debian (Engels talig!).

Merk op dat alle probleemrapporten in het Engels moeten worden ingediend

Een probleem in Debian rapporteren via e-mail (en geavanceerd gebruik van reportbug)

Belangrijke zaken om in gedachten te houden vóórdat u een probleem rapporteert

Tot welk pakket behoort uw probleemrapport?

U dient te weten tegen welk pakket u uw probleem gaat rapporteren. Zie dit voorbeeld voor informatie over hoe dit uit te vinden. (Deze informatie zal u gebruiken om te controleren of het probleem al gerapporteerd is.)

Als het niet lukt om te bepalen tegen welk pakket een probleem gerapporteerd moet worden, kunt u een e-mail sturen naar de mailinglijst voor gebruikers van Debian en daar om hulp vragen (in het Engels!).

Als uw probleem niet direct te maken heeft met een specifiek pakket, maar met een algemeen aspect van Debian, kunt u dit melden door een bug te rapporteren tegen een pseudo-pakket of door een e-mail te sturen naar een van de mailinglijsten van Debian.

Is uw probleem reeds gerapporteerd?

Bekijk of het probleem dat u wilt rapporteren niet al door iemand anders is gemeld voordat u het zelf indient. U kunt zien welke problemen voor een bepaald pakket zijn gerapporteerd door de naam van het pakket in te geven op het zoekformulier voor probleemrapporten. Als er al een bestaand probleemrapport is, met nummer #<number>, dan kunt u aanvullende informatie daaraan toevoegen door een e-mail te sturen aan <number>@bugs.debian.org. Dien in elk geval niet nieuw probleemrapport in.

Dien afzonderlijke rapporten in voor verschillende problemen

Rapporteer liever niet meerdere ongerelateerde bugs in één enkel bugrapport, zeker niet als het bugs in verschillende pakketten betreft.

Dien geen probleemrapporten in upstream

Als u een probleem rapporteert binnen Debian, rapporteer het probleem dan niet ook zelf bij de upstream ontwikkelaars van de programmatuur. Het is immers mogelijk dat het probleem alleen voorkomt in Debian. Indien nodig zal de beheerder van het pakket uw rapport doorsturen.

Een bug via e-mail rapporteren

U kunt problemen in Debian ook indienen door een e-mail te sturen naar submit@bugs.debian.org. Hiervoor is een speciale indeling nodig die hieronder wordt beschreven. Omdat reportbug (zie boven) deze indeling automatisch verzorgt, wordt gebruik ervan sterk aangeraden!

Headers

Net als bij een normaal e-mail bericht, dient u een duidelijk, beschrijvend Onderwerp voor uw e-mail kiezen. Het onderwerp dat u invult, zal worden gebruikt als de titel van de bug in het Bug Tracking Systeem. Probeer dus een informatieve regel als onderwerp te gebruiken!

Als u een kopie van het bericht ook naar andere mensen (of een mailinglijst) wilt sturen, kunt u beter niet de standaard e-mail headers (zoals CC) gebruiken, maar een andere methode, die verderop wordt beschreven.

Pseudo-headers

De eerste regels van het bericht zelf bepalen, door het gebruik van zogenaamde pseudo-headers, op welk pakket en welke versie van dat pakket uw rapport betrekking heeft. Dit betekent dat de eerste regel van uw bericht er als volgt moet uitzien:

Package: <pakketnaam>

Vervang hier <pakketnaam> door de naam van het pakket (of het pseudo-pakket) waarover u een bug wilt rapporteren.

De tweede regel dient er als volgt uit te zien:

Version: <versie>

Vervang hier <versie> door de versie van het pakket dat u gebruikt. Voeg geen tekst toe aan de versie zelf, want het Bug Tracking Systeem steunt op dit veld om uit te zoeken welke releases getroffen worden door deze bug.

De Package regel in uw bericht moet correct zijn, omdat deze informatie door het Bug Tracking Systeem wordt gebruikt om uw bericht door te sturen naar de ontwikkelaar die verantwoordelijk is voor dit specifieke pakket. In dit voorbeeld wordt uitgelegd hoe u deze informatie kunt achterhalen.

Onder overige pseudo-headers vindt u welke andere pseudo-headers zijn toegestaan.

De eigenlijke probleemmelding

U wordt verzocht de volgende informatie in uw rapport te vermelden:

De exacte en complete tekst van alle foutmeldingen die op het scherm worden getoond of in de logfiles worden opgeslagen. Dit is erg belangrijk!
Wat u precies typte of deed toen het probleem optrad.
De beschrijving van het foute gedrag: welk gedrag verwachtte u precies en wat gebeurde er? Een transcriptie van een voorbeeldsessie is een goede manier om dit duidelijk te maken.
Een suggestie om het probleem op te lossen, of misschien zelfs een patch, als u die heeft.
De details van de configuratie van het programma dat het probleem vertoont. Neem de complete tekst van de configuratiebestanden in uw mail op.
De versies van de pakketten waarvan het pakket met de fout afhangt.
De kernel versie die u gebruikt (typ uname -a), de versie van uw standaard C bibliotheek (type dpkg -s libc6 | grep ^Version) en alle andere details van de configuratie van uw systeem, als dat nodig lijkt. Bijvoorbeeld, als u een probleem met een Perl script rapporteert, kunt u het beste ook de versie van het 'perl' programma zelf opnemen in uw rapport (type perl -v of dpkg -s perl | grep ^Version:).
Details van uw hardwareconfiguratie, als dat relevant lijkt. Indien u een probleem met een device driver rapporteert, stuur dan een lijst mee van alle hardware in uw systeem, omdat dit soort problemen vaak worden veroorzaakt door conflicten van IRQ's of I/O adressen.
Als het pakket reportbug is geïnstalleerd, kan ook de uitvoer van reportbug -q --template -T none -s none -S normal -b --list-cc none -q <package> nuttig zijn. Dit bevat versie-informatie en de uitvoer van speciale scripts van de pakketbeheerder.

Neem ieder detail dat relevant lijkt op in uw bericht. Er is weinig kans dat uw bericht door dit soort informatie te lang wordt. Verder kunt u, als de bestanden niet te groot zijn, de bestanden die u gebruikte om het probleem te reproduceren, meesturen. (Als de bestanden groot zijn, overweeg dan om ze, indien mogelijk, beschikbaar te stellen op een openbaar toegankelijke website.

Meer informatie over hoe u de ontwikkelaars kunt helpen om uw probleem op te lossen kunt u vinden op de "How to Report Bugs Effectively"-pagina (engelstalig).

Voorbeeld van een probleemrapport

Een bug rapport, inclusief de mail header en pseudo-headers, ziet er ongeveer als volgt uit:

  To: submit@bugs.debian.org
  From: diligent@testing.linux.org
  Subject: Hello says `goodbye'

  Package: hello
  Version: 1.3-16

  When I invoke `hello' without arguments from an ordinary shell
  prompt it prints `goodbye', rather than the expected `hello, world'.
  Here is a transcript:

  $ hello
  goodbye
  $ /usr/bin/hello
  goodbye
  $

  I suggest that the output string, in hello.c, be corrected.

  I am using Debian GNU/Linux 2.2, kernel 2.2.17-pre-patch-13
  and libc6 2.1.3-10.

Het versturen van bug rapporten naar andere ontvangers

Soms is het nodig om een kopie van uw bug rapport op te sturen naar iemand anders dan debian-bugs-dist en de ontwikkelaar die verantwoordelijk is voor het pakket.

U zou dit kunnen doen door simpelweg een CC te sturen naar de andere adressen, maar dan krijgen deze kopieën geen bug nummer in de Reply-To en de Subject regels van het bericht. Als de ontvangers van de kopieën reageren op de mail, zullen ze waarschijnlijk de submit@bugs.debian.org als ontvanger van het bericht behouden, met als gevolg dat hun antwoord als een nieuw bug rapport wordt gezien door het Bug Tracking Systeem. Dit leidt tot veel dubbele rapporten.

De goede manier om dit te doen, is door de X-Debbugs-CC header te gebruiken. Voeg een regel zoals hieronder toe aan de header van uw e-mail bericht:

 X-Debbugs-CC: other-list@cosmic.edu

Dit zorgt ervoor dat het Bug Tracking Systeem, behalve naar debian-bugs-dist, ook een kopie van uw rapport naar de adressen in de X-Debbugs-CC stuurt.

Vermijd alstublieft het sturen van zulke kopieën naar de adressen van andere bugrapporten; deze worden afgevangen door de controles die mailloops voorkomen. Het heeft ook weinig zin om de X-Debbugs-CC-header hiervoor te gebruiken, omdat het bugnummer dat door dit mechanisme aan uw mail wordt toegevoegd, gewoon door een nieuwe zal worden vervangen; u kunt beter de standaard CC header gebruiken.

Het is vaak zinvol te deze optie te gebruiken in combinatie met de quiet verzend optie (zie hieronder).

Overige pseudo-headers

Zwaarte van de bugs

Als u een probleem rapporteert dat bezonder ernstig is, of als u juist slechts een wens heeft voor extra functionaliteit van het programma, kunt u de ernst van de bug aangeven. Dit is echter niet verplicht, en de pakketbeheerder kan een juiste ernst aan uw rapport toekennen, als u het niet zelf doet (of een onjuiste ernst heeft gekozen).

Om de ernst aan te geven, kunt u een regel zoals hieronder in de pseudo-header invoegen:

Severity: <ernst>

Vervang <ernst> met een van de gedefineerde niveaus zoals beschreven in de aanvullende documentatie.

Het toewijzen van labels (tags)

Het is mogelijk om labels (tags) aan een bug-rapport toe te wijzen als u deze instuurt. Als u bijvoorbeeld een oplossing in uw bugreport meestuurt, kunt u het patch-label zetten. Dit is echter niet verplicht; de ontwikkelaars zullen zelf uw bug-rapport labels geven als dat nodig is.

Om een label toe te wijzen kunt u een regels zols hieronder in de pseudo-header toevoegen:

Tags: <tags>

Hier moet u uiteraard <tags> vervangen door een of meerdere beschikbare labels. De labels die beschikbaar zijn, zijn beschreven in de aanvullende documentatie. Als u meerdere tags wilt opgeven, moeten deze gescheiden worden door komma's, spaties of beide.

User: <gebruikersnaam>
Usertags: <gebruikertags>

Vervang <gebruikertags> door één of meerdere gebruikertags. Scheidt meerdere tags door comma's, spaties of beide. Als u een <gebruikersnaam>opgeeft, zullen de tags voor die gebruiker worden gezet. Anders zal het e-mailadres van de afzender worden gebruikt als gebruikersnaam.

Forwarded: foo@example.com

duidt de gerapporteerde bug aan als doorgestuurd naar foo@example.com. Zie aanduiden dat je een bugrapport hebt doorgegeven in de documentatie voor ontwikkelaars voor details.

Owner: foo@example.com

duidt aan dat foo@example.com nu verantwoordelijk is om deze bug op te lossen. Zie wijzig eignaar van een bug in de documentatie voor ontwikkelaars voor details.

Source: foopackage

het equivalent van Package: voor bugs in het bronpakket foopackage; voor de meeste bugs, gebruikt u deze optie beter niet.

Ten slotte, als je MUA je niet toelaat om de headers te wijzigen, dan kunt u de verschillende X-Debbugs--headers in de pseudo-headers vermelden.

Aanvullende informatie

Verschillende rapporteeradressen (rapporteren van kleine bug of heel veel bugs tegelijk)

Als u een klein probleem rapporteert zoals een typo in de documentatie of een triviaal bouw probleem, wordt u verzocht de ernst van uw bug rapport daaraan aan te passen en uw rapport aan maintonly@bugs.debian.org te sturen in plaats van submit@bugs.debian.org. Dit zorgt ervoor dat uw bericht alleen wordt doorgestuurd naar de ontwikkelaar van het pakket en niet naar de bug mailinglijsten.

Als u veel bugs tegelijkertijd rapporteert, moet u zeker maintonly@bugs.debian.org gebruiken, zodat u niet te veel e-mail verkeer veroorzaakt op de Bug Tracking mailinglijsten. Voordat u veel dezelfde bugs rapporteert, kunt u het beste ook een samenvatting sturen naar de debian-bugs-dist lijst.

Als u een bug wilt rapporteren die al eerder naar de ontwikkelaar is gestuurd, kunt u quiet@bugs.debian.org gebruiken. Bugs die naar dit adres worden gestuurd, worden alleen opgenomen in het Bug Tracking Systeem en verder naar niemand doorgestuurd.

Als uw verschillende rapporteeradressen gebruikt, zal het Bug Tracking Systeem automatisch de Reply-To header van alle doorgestuurde berichten zetten, zodat de antwoorden op deze berichten op dezelfde manier worden behandeld als het originele rapport. Dat betekent bijvoorbeeld, dat antwoorden op maintonly naar nnn-maintonly@bugs.debian.org zullen worden gestuurd in plaats van naar nnn@bugs.debian.org, tenzij iemand dat handmatig aanpast.

Bevestigingen

Normaliter stuurt het Bug Tracking Systeem u per e-mail een bevestiging wanneer u een nieuwe bug rapporteert of extra informatie aan een bestaande bug toevoegt. U kunt deze bevestiging onderdrukken door een X-Debbugs-No-Ack-header toe te voegen in uw e-mailbericht. De inhoud van deze header maakt niet uit; het moet echter wel een echte header zijn en hij moet niet in de pseudo-header met het Package-veld. Als u van de header gebruikmaakt, zult u zelf in de www-interface op zoek moeten naar het nummer van de bug als u deze nodig hebt.

Merk op dat deze header niet de bevestigingen van de control@bugs.debian.org-server onderdrukt. Deze kunnen namelijk foutmeldingen bevatten naar aanleiding waarvan u nog actie moet ondernemen.

Bugs in onbekende pakketten

Als het Bug Tracking Systeem niet kan bepalen welke ontwikkelaar verantwoordelijk is voor het relevant pakket, zal het rapport worden doorgestuurd naar debian-bugs-dist, zelfs als het rapport naar maintonly is gestuurd.

Als u berichten stuurt naar maintonly@bugs.debian.org of nnn-maintonly@bugs.debian.org, moet u ervoor zorgen dat het rapport aan het goede pakket is toegewezen. Dat kunt u doen door een correcte Package header bovenaan het rapport te zetten, of door de control@bugs.debian.org service te gebruiken.

Het gebruik van `dpkg` om het pakket en de versie voor het report te vinden

Als u reportbug gebruikt om een probleem te rapporteren met een bepaald commando, zeg grep, kan op de volgende manier automatisch het juiste pakket worden bepaald en kunt u meteen het rapport schrijven: reportbug --file $(which grep).

U kunt ook uitvinden welk pakket een commando installeerde door dpkg --search te gebruiken. U kunt uitvinden welke versie van een bepaald pakket u heeft geïnstalleerd met het commando dpkg --list of dpkg --status.

Bijvoorbeeld:

$ which apt-get
/usr/bin/apt-get
$ type apt-get
apt-get is /usr/bin/apt-get
$ dpkg --search /usr/bin/apt-get
apt: /usr/bin/apt-get
$ dpkg --list apt
Desired=Unknown/Install/Remove/Purge/Hold
| Status=Not/Installed/Config-files/Unpacked/Failed-config/Half-installed
|/ Err?=(none)/Hold/Reinst-required/X=both-problems (Status,Err: uppercase=bad)
||/ Name           Version        Description
+++-==============-==============-============================================
ii  apt            0.3.19         Advanced front-end for dpkg
$ dpkg --status apt
Package: apt
Status: install ok installed
Priority: standard
Section: base
Installed-Size: 1391
Maintainer: APT Development Team <deity@lists.debian.org>
Version: 0.3.19
Replaces: deity, libapt-pkg-doc (<< 0.3.7), libapt-pkg-dev (<< 0.3.7)
Provides: libapt-pkg2.7
Depends: libapt-pkg2.7, libc6 (>= 2.1.2), libstdc++2.10
Suggests: dpkg-dev
Conflicts: deity
Description: Advanced front-end for dpkg
 This is Debian's next generation front-end for the dpkg package manager.
 It provides the apt-get utility and APT dselect method that provides a
 simpler, safer way to install and upgrade packages.
 .
 APT features complete installation ordering, multiple source capability
 and several other unique features, see the Users Guide in
 /usr/doc/apt/guide.text.gz

Overige nuttige commando's en pakketten

Het hulpprogramma querybts, beschikbaar in hetzelde pakket als reportbug, biedt een handige textuele interface naar het Bug Tracking Systeem.

Gebruikers van Emacs kunnen ook het commando debian-bug uit het pakket debian-el gebruiken. Wanneer aangeroepen met behulp van M-x debian-bug, zal het op een vergelijkbare wijze als reportbug vragen om alle benodigde informatie.

Andere BTS pages:

Debian BTS administrators <owner@bugs.debian.org>