[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

[Debian]: Über die Wichtigkeit von Bug Reports



Hallo Leute,

anläßlich einer Mail auf dieser Liste möchte ich unter einer treffenden
Subject Zeile die Wichtigkeit von Bug Reports betonen.


o  Was ist ein Bug?

  bug /n./  An unwanted and unintended property of a program or
     piece of hardware, esp. one that causes it to malfunction.
     Antonym of {feature}.  Examples: "There's a bug in the editor:
     it writes things out backwards."  "The system crashed because of
     a hardware bug."  "Fred is a winner, but he has a few bugs"
     (i.e., Fred is a good guy, but he has a few personality problems).

Ein Bug ist ein unerwünschtes Fehlverhalten der Software. Dies kann
vorliegen, wenn die Dokumentation etwas anderes verspricht als die Software
tatsächlich durchführt. Oder wenn die Ausgabe eines Programms fehlerhaft
ist. Rechtschreib- und Grammatikfehler sind Bugs. Fehler in der Installation
und Configuration eines Debian Pakets sind Bugs. Auch Probleme bei der
Deinstallation können Bugs sein.

Manchmal ist eine fehlende Funktion ein Bug, aber manchmal ist dies auch
beabsichtigt.

Eine falsche Klassifikation des Debian Pakets bezüglich der DFSG ist ein Bug
(z.B. wenn ein nicht freies Programm in der Main distribution ist).


o  Was ist ein Bug Report?

Ein Bug Report ist eine Meldung über einen Bug in der Debian distribution.
Sie können per email an die Adresse <submit@bugs.debian.org> eine
Fehlermeldung an Debian verschicken. Dazu sollte der Mail ein Pseudo-Header
vorangestellt werden:

Package: hello
Version: 0.9.7-2

The output of `hello' is "good bye", which seems to be wrong...


Der Pseudo Header hilft, die Mail automatisch zu bearbeiten. Erlaubt sind
"Package", "Version" und "Severity".

Der Text der Mail sollte in Englisch sein. Angst sollte keiner haben,
niemand wird die Mail auf Grammatik- oder Rechtschreibfehler kontrollieren.
Wichtig ist, daß man verstanden wird.

Nach dem Absenden der Mail sollte gewartet werden, bis eine automatische
Bestätigung erfolgt ist. In der steht dann die Bug Nummer (z.B. #28763),
unter der zusätzliche Informationen gegeben werden können. Die Adresse für
den speziellen Bug Report lautet dann nummer@bugs.debian.org, zum Beispiel
28763@bugs.debian.org.


o  Wie dringend ist der Bug?

Normalerweise wird ein Bug report als "normal" eingestuft. Will man dem
Maintainer nur einen Wunsch mitteilen, z.B. eine fehlende Funktionalität, so
kann "Severity: wishlist" angegeben werden, um dies zu signalisieren.

Es gibt auch höhere Dringlichkeiten, die aber nur unter genau definierten
Umständen verwendet werden dürfen. Diese Einschätzung ist den Debian
Developern überlassen werden.


o  Was gehört in einen Bug Report?

Ein Bug Report sollte immer die genaue Fehlerbeschreibung enthalten. Bug
Reports, die keine Angaben enthalten, wie der Fehler reproduziert werden
kann, können meist nicht sehr gut bearbeitet werden. 

Wichtig ist, lokale Veränderungen an der Konfiguration mitzuteilen. Auch die
Versionen relevanter anderer Pakete ist nützlich. Gibt es Vermutungen
bezüglich der Fehlerursache, so können sich auch diese als nützlich
erweisen.

Immer gern gesehen wird es, wenn der Fehlermeldung schon eine Korrektur des
Programms beigefügt wird (patch). Fehlende Erklärung oder
Verbesserungsvorschlag sollte aber niemals ein Grund sein, das Abschicken
eines Bug Reports zu verzögern oder gar zu unterlassen.


o  Was sollte ich vor dem Absenden eines Bug Reports beachten?

Man sollte den Bug möglichst mit der aktuellen Paketversion bestätigen, am
besten mit der Version aus der unstable Distribution. Wenn dies nicht
angebracht ist, sollte man natürlich trotzdem den Bug Report verschicken!

Man sollte sich halbwegs sicher sein, daß der Bug nicht nur eine falsche
Konfiguration darstellt, sondern wirklich im Widerspruch zur Dokumentation
(falls vorhanden) steht.

Wer Gelegenheit hat, kann im Bug Tracking System nachsehen, ob jemand anders
den Bug schon vorher gefunden hat (s.u.).


o  Was ist das Bug Tracking System?

Das BTS ist die Debian Datenbank der Unzulänglichkeiten. Über die Webseite
http://www.de.debian.org/Bugs können einzelne Bug Reports über die Nummer
oder über den Paketnamen eingesehen werden. Auch komplette Listen aller Bugs
sind erhältlich.


o  Das scheint mir alles viel zu kompliziert!

Ist es nicht! Einfach das Paket "bug" installieren, und dann:

debian$ bug paketname

wobei paketname der Name des Paketes ist, gegen das man einen Bug Report
schicken will. Bug erstellt automatisch den Pseudo Header, und fügt auch
relevant Konfigurationsdateien an die Mail an. Dann startet es den
Texteditor und man kann seine Fehlermeldung schreiben. Mit der Maus noch
schnell die Ausgabe des Programs rüberkopiert, fertig.


o  Warum soll ich überhaupt einen Bug Report verschicken?

Zum einen natürlich, um selber Hilfe zu erhalten. Denn durch das Absenden
eines Bug Reports werden andere aktiviert und nach einer Lösung für das
Problem suchen. Wenn der Debian maintainer die Lösung nicht weißt, wird der
Originalauthor angefragt. Wenn der Debian maintainer die Lösung weiß, kommt
eine neue Version des Pakets, und der Originalauthor erhält den patch.
Der Debian maintainer dient somit als Zwischenstufe zwischen dem User und
dem Author. Dadurch werden Debian interne Fehler abgefangen.

Zum anderen natürlich, um die Qualität der Debian zu verbessern. Durch das
Beheben eines Fehlers auf dem lokalen Rechner kann nur eine kleine Gruppe
profitieren. Kommt der patch in das Debian Paket, sind es gleich viele
Tausende, wird er weitergereicht an den Originalauthor, geht es in die
Millionen. Darum sind Fehlermeldungen genauso wichtig, oder sogar noch
wichtiger, als neuer Code.

Jeder kann sich daran beteiligen, und es fordert nur ganz wenig Mühe. Die
Beteiligung von vielen Einzelleuten an dem Gesamtprojekt kommt hier ganz
besonders zu tragen, denn oft treten Bugs nur unter ganz besonderen
Umständen auf. Man benötigt also eine breite Test Basis, um möglichst viele
Fehler auszumerzen.


o  Ich habe keine Antwort auf meinen Report erhalten!

Unwahrscheinlich, aber es passiert. Manche Maintainer sind überlastet,
manche sind seltener zu erreichen. Manchmal wird ein Paket nicht mehr aktiv
gewartet. In solchen Fällen hilft es meist nicht, eine zweite Meldung an die
Bug Adresse zu schreiben. Da ist dann Geduld gefragt, oder man macht andere
Benutzer bei Gelegenheit auf den Mißstand aufmerksam, wenn man nicht selbst
aktiv daran arbeiten will.

Glücklicherweise passiert dies sehr selten. Die meisten Maintainer reagieren
zügig auf Bug Reports.

Da Debian ein Projekt von Freiwilligen ist, lebt es von Eurer Mithilfe. Das
Versenden eines Bug Reprots, selbst wenn er unbeantwortet bleibt, ist auf
jeden Fall besser als kein Bug Report, denn die Fehlermeldung befindet sich
im ersteren Fall im Archiv, und kann dort von anderen eingesehen werden.

Wer jetzt immer noch besorgt ist, daß sein Bug Report umsonst sein könnte,
dem biete ich an, mir zu schreiben, falls er innerhalb von zwei Wochen
nichts über seinen Bug Report hört. Ich werde dann persönlich versuchen zu
klären, woran es liegt. Ich erwarte nicht, daß durch dieses Angebot viel
Arbeit auf mich zukommt ;)


o  Wo finde ich mehr Infos?

http://www.de.debian.org/Bugs
http://cgi.debian.org/www-master/debian.org/Packages/stable/utils/bug.html

/usr/doc/debian/bug-*   in Paket debian-doc.


Tschüß,
Marcus
 
-- 
"Rhubarb is no Egyptian god."        Debian GNU/Linux        finger brinkmd@ 
Marcus Brinkmann                   http://www.debian.org    master.debian.org
Marcus.Brinkmann@ruhr-uni-bochum.de                        for public  PGP Key
http://homepage.ruhr-uni-bochum.de/Marcus.Brinkmann/       PGP Key ID 36E7CD09
------------------------------------------------
Um sich aus der Liste auszutragen schicken Sie
bitte eine E-Mail an majordomo@jfl.de die im Body
"unsubscribe debian-user-de <your_email_address>"
enthaelt.
Bei Problemen bitte eine Mail an: Jan.Otto@jfl.de
------------------------------------------------
Anzahl der eingetragenen Mitglieder:     624


Reply to: