Hvordan man rapporterer en fejl i Debian vha. reportbug

Vi anbefaler kraftigt at du rapporterer fejl i Debian ved hjælp af programmet reportbug. For at installere og starte programmet, kør blot:

# aptitude install reportbug
$ reportbug

Programmet leder dig gennem fejlrapporteringsprocessen, trin for trin.

Hvis du har spørgsmål, som reportbugs interaktive spørgsmål ikke besvarerer, kan du kiggede på denne dokumentation, spørge på engelsk på postlisten debian-user eller på dansk på postlisten debian-user-danish.

Hvordan man rapporterer en fejl i Debian vha. e-mail (samt avanceret anvendelse af reportbug)

Vigtige to at notere sig inden man sender sin fejlrapport

Hvilken pakke hører fejlrapporten til?

Du skal vide hvilken pakken, din fejlrapport skal rapporteres imod. Se eksemplet for oplysninger om hvordan man finder denne oplysning. (Du skal bruge oplysningen for at afgøre hvorvidt fejlen allerede er rapporteret.)

Hvis du ikke kan afgøre hvilken pakke, din fejl skal rapporteres imod, så send venligst en e-mail på engelsk til postlisten debian-user hvor du beder om hjælp.

Hvis dit problem ikke er relateret til kun én pakke, men en generel Debian-tjeneste, er der flere pseudopakker eller postlister, som du i stedet kan sende din besked til.

Er din fejl allerede blevet rapporeret?

Du bør undersøge om fejlen allerede er blevet rapporteret, før du indsender din fejlrapport. Du kan se hvilke fejl, der er blevet rapporteret om en given pakke ved hjælp af fejlsøgningsformularens pakke-del. Hvis der allerede er et fejlrapport-#<nummer>, bør du på engelsk indsende dine bemærkninger, ved at sende en e-mail til <nummer>@bugs.debian.org i stedet for at rapportere en ny fejl.

Send flere rapporter om flere fejl

Rapportér venligst ikke om flere uafhængige fejl – særlig ikke hvis de er i forskellige pakker – i en enkelt fejlrapport.

Send ikke fejlrapporter til opstrømsudviklerne

Hvis du indsender en fejlrapport til Debian, skal du ikke selv sende en kopi til opstrømsudviklerne, da det er muligt at fejlen kun findes i Debian. Om nødvendigt vil Debian-pakkens vedligeholder sende fejlen videre til opstrømsudviklerne.

Indsendelse af fejlrapport vha. e-mail

Du kan rapportere fejl i Debian ved at sende en e-mail til submit@bugs.debian.org i et særligt format beskrevet herunder. reportbug (se ovenfor) formaterer mailen korrekt for dig; brug programmet!

Headers

Som i alle andre e-mails skal du vælge en præcis og beskrivende Emne-linje i e-mail'en. Det emne du vælger vil i begyndelsen blive anvendt som fejloverskrift i rapportsystemet, så prøv venligst at gøre den informativ!

Hvis du ønsker at sende en kopi af din fejlrapport til yderligere modtagere (så som postlister), skal du ikke anvende de gængse e-mail-headere, men en anden metode, beskrevet herunder.

Pseudo-headere

Den første del af fejlrapporten er pseudo-headeren, der indeholder oplysninger om hvilken pakke og version, din fejlrapport drejer sig om. Den første linje i meddelelsen skal indeholde en pseudo-header, som skal være:

Package: <pakkenavn>

Erstat <pakkenavn> med navnet på den pakke, der indeholder fejlen.

Meddelelsens anden linje skal være:

Version: <pakkeversion>

Erstat <pakkeversion> med versionen på pakken. Undlad at tilføje anden tekst her end selve versionen, da fejlsporingssystemet er afhængigt af dette felt, for at kunne afgøre hvilke udgivelser, der er påvirket af fejlen.

Du er nødt til at angive en korrekt Package-linje i pseudo-headeren, så fejlsporingssystemet kan levere meddelelsen til pakkens vedligeholder. Se eksemplet for oplysninger om hvordan du finder pakkens navn og versionsnummer.

For andre gyldige pseudo-headere, se yderligere pseudo-headers.

Rapportens tekst

Følgende skal medtages i din rapport:

Inkludér alle oplysninger du mener er relevante — risikoen for at for gøre din rapport for lang ved at inkludere for mange oplysninger er lille. Hvis de er små, så inkludér alle de filer du brugte til at genskabe problemet (hvis de er store, så overvej om muligt at placere dem på et offentligt tilgængeligt websted).

For flere råd om hvordan du hjælper udviklerne med at løse dit problem, læs Effektiv fejlrapportering (på engelsk).

Eksempel på en fejlrapport

En fejlrapport, der skal skrives på engelsk, inklusive header og pseudo-header, ser nogenlunde således ud:

  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.

Afsendelse af kopier af fejlrapporten til andre adresser

Nogle gange er det nødvendigt at sende kopier af en fejlrapport til andre steder end debian-bugs-dist og pakkens vedligeholder, hvortil de normalt sendes.

Du kan gøre det ved at sende en kopi (CC) af din fejlrapport til de andre adresser, men så vil disse kopier ikke indeholde fejlrapportnummeret i Reply-To-feltet og Emne-linjen. Når modtagerne svarer vil de formentlig bevare submit@bugs.debian.org-linjen i brevhovedet og dermed få deres meddelelse gemt som en ny fejlrapport. Dette resulterer i mange ens rapporter.

Den rigtige måde at gøre dette på, er at bruge X-Debbugs-CC-linjen i e-mailens brevhoved. Tilføj en linje som denne til din e-mails brevhoved:

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

Dette vil få fejlsporingssystemet til at sende en kopi af din rapport til både adresserne i X-Debbugs-CC-linjen og til debian-bugs-dist.

Undgå at sende sådanne kopier til andre fejlrapporters adresser, da de vil blive fanget af de kontroller, der forhindrer postløkker. Der er alligevel en relativt ringe grund til at anvende X-Debbugs-CC til dette, da fejlnummeret som tilføjes af denne mekanisme, blot vil udskifte nummeret med et nyt; anvend i stedet en almindelig CC-header.

Denne funktion kan ofte kombineres med at skrive til quiet – se nedenfor.

Yderligere pseudo-headere

Alvorsgrader

Hvis der rapporteres en særligt alvorlig fejl, eller er det bare et ønske om ny funktionalitet, kan du angive alvorsgraden på fejlen når du rapporterer den. Dette er dog ikke påkrævet, og pakkens vedligeholder vil fastsætte en passende alvorsgrad på din rapport, også selv om du ikke selv gør det (eller vælger en forkert alvorsgrad).

For at angive en alvorsgrad skal du tilføje en linje som denne til pseudo-brevhovedet:

Severity: <alvorsgrad>

Erstat <alvorsgrad> med en de mulige alvorsgrader, som beskrevet i dokumentationen for viderekommende.

Tildeling af mærker (tags)

Man kan sætte mærker (tags) på en fejl, når man rapporterer den. For eksempel hvis man vedhæfter en rettelse til fejlrapporten, kan man sætte mærket patch. Dette er dog ikke krævet, og udviklerne vil sætte mærker på rapporterne når og hvis det er nødvendigt.

For at sætte mærker, indsættes en linje som den nedenstående i pseudo-brevhovedet:

Tags: <mærker>

Erstat <mærker> med en eller flere at de tilgængelige mærker, som beskrevet i vejledningen for viderekommende. Adskil flere mærker med komma, mellemrumstegn eller begge dele.

User: <brugernavn>
Usertags: <brugermærker>

Erstat <brugermærker> med et eller flere brugermærker. Adskil flere mærker med kommaer, mellemrum eller begge dele. Hvis du angiver et <brugernavn>, vil denne brugers brugermærker blive sat. Ellers vil afsenderens e-mail-adresse blive anvendt som brugernavn.

Opsætning af Forwarded

Forwarded: foo@example.com

markerer den nyligt indsendte fejl som videresendt til foo@example.com. Se registrering af at du har videresendt en fejlrapport i udviklerdokumentationen for flere oplysninger.

Tage ejerskab

Owner: foo@example.com

indikerer at foo@example.com nu er ansvarlig for at rette fejlen. Se ændring af en fejls ejerskab i udviklerdokumentationen for flere oplysninger.

Kildekodepakke

Source: foopackage

svarer til Package: til fejl i kildekodepakken hørende til foopackage; for de fleste fejl i de fleste pakker, skal du ikke anvende denne mulighed.

Kontrolkommandoer

Control: control commands

Gør det muligt for enhver af kommandoerne, der skal sendes til control@bugs.debian.org, at fungere når de sendes til submit@bugs.debian.org eller nnn@bugs.debian.org. I begyndelsen refererer -1 til den aktuelle fejl (det vil sige fejlen oprettet af en mail til submit@ eller fejlen meddelt til nnn@). Se serverkontrol-dokumentationen for flere oplysninger om de gyldige kontrolkommandoer.

Eksempelvis vil følgende pseudoheader i en meddelelse sendt til 12345@bugs.debian.org:

Control: retitle -1 this is the title
Control: severity -1 normal
Control: summary -1 0
Control: forward -1 http://bugs.debian.org/nnn

medføre at 12345 får en ny titel, får ændret sin alvorlighedsgrad, får opsat et resumé samt bliver markeret som videresendt.

X-Debbugs-headere

Slutteligt, hvis din MUA ikke tillader, at de redigerer i headerlinjerne, kan du opsætte de forskellige X-Debbugs-headere som pseudoheaderne.

Yderligere oplysninger

Forskellige rapporteringsadresser (mindre rapporter eller masse-rapportering)

Hvis en rapporteret fejl er mindre, for eksempel en tastefejl i dokumentationen eller andre trivielle problemer, så opsæt alvorsgraden tilsvarende og send den til maintonly@bugs.debian.org i stedet for submit@bugs.debian.org. maintonly vil kun videresende rapporten til pakkens vedligeholder, den vil ikke videresende rapporten til BTS-postlisterne.

Hvis du sender mange rapporter på én gang, så send dem til maintonly@bugs.debian.org så du ikke er skyld i en masse unødig trafik i BTS-postlisterne. Før du sender mange ens fejlrapporter, kan det være en god idé at poste et sammendrag i debian-bugs-dist.

Hvis du ønsker at rapportere en fejl som allerede er sendt til vedligeholderen, kan du bruge quiet@bugs.debian.org. Fejl sendt til quiet@bugs.debian.org vil ikke blive videresendt, men kun blive arkiveret.

Når du anvender forskellige indsendelsesadresser vil fejlsystemet sætte Reply-To på eventuelt videresendte meddelelser, således at svar automatisk vil blive behandlet på samme måde som den originale rapport. Der betyder at, for eksempel svar til maintonly vil blive sendt til nnn-maintonly@bugs.debian.org i stedet for nnn@bugs.debian.org, selvfølgelig med mindre de manuelt ændres.

Anerkendelser

Normalt vil fejlhåndteringssystemet returnere en anerkendelse til dig via e-mail, når du rapporterer en ny fejl eller indsender yderligere oplysninger til en eksisterende fejl. Hvis du ønsker at undertrykke denne anerkendelse, skal din e-mail indeholde en X-Debbugs-No-Ack-header eller -pseudoheader (indholdet af denne header er ligegyldigt). Hvis du rapporterer en ny fejl med denne header, skal du via webgrænsefladen selv finde ud af fejlnummeret.

Bemærk, at denne header ikke undertrykker anerkendelser fra postserveren control@bugs.debian.org, da disse anerkendelser kan indeholde fejlmeddelelser, der skal læses og reagere på.

Spambekæmpelse og manglende mail

Fejlsporingssystemet (BTS) indeholder et ganske omfattende regelsæt, med det formål at sikre, at spam ikke kommer igennem til systemet. Mens vi forsøger at minimere antallet af falske positive, optræder de ind i mellem. Hvis du har mistanke om, at din mail er blevet registreret som en falsk positiv, er du velkommen til på engelsk at kontakte owner@bugs.debian.org for at få hjælp. En anden hyppig årsag til at mail ikke kommer igennem til BTS, er anvendelse af adresser, der svarer til procmails FROM_DAEMON, der indeholder mail fra adresser så som mail@foobar.com. Hvis du har mistanke om at din mail svarer til FROM_DAEMON, se procmailrc(5) for at kontrollere, og genudsend dernæst mailen fra en adresse, der ikke svarer til FROM_DAEMON.

Fejlrapporter mod ukendte pakker

Hvis fejlsporingssystemet ikke ved hvem vedligeholderen af en relevant pakke er, vil det videresende rapporten til debian-bugs-dist også selvom maintonly er angivet.

Når du sender til maintonly@bugs.debian.org eller nnn-maintonly@bugs.debian.org skal du sikre dig at fejlrapporten hæftes på den rigtige pakke, ved enten at angive en korrekt Package øverst i den originale rapport, eller ved at bruge control@bugs.debian.org-tjenesten til at hæfte rapporten på den rette pakke.

Brug af dpkg til at finde pakke og versionsnummer til brug i rapporten

Når du anvender reportbug til at rapportere om en fejl i en kommando, eksempelvis grep, vil følgende automatisk uden videre vælge den rigtige pakke: reportbug --file $(which grep)

Du kan også finde ud af hvilken pakke installerede kommandoen, ved at anvende dpkg --search. Du kan finde ud af hvilken version af en pakke, der er installeret, ved at anvende dpkg --list eller dpkg --status.

For eksempel:

$ 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

Andre nyttige kommander og pakker

Værktøjet querybts, tilgængeligt i den samme pakke som reportbug, indeholder en praktisk tekstbaseret grænseflade til fejlsporingssystemet.

Emacs-brugere kan også anvende kommandoen debian-bug, der er i pakken debian-el. Når programmet køres med M-x debian-bug, spørger det om alle nødvendige oplysninger på en måde, der svarer til reportbug.


Andre sider i fejlrapporteringssystemet:


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

Debian bug tracking system
Copyright © 1999 Darren O. Benham, 1997, 2003 nCipher Corporation Ltd, 1994-1997 Ian Jackson.