Varoitus! Tämä suomennos on liian vanha, katso mieluummin alkuperäistä sivua.

Kuinka reportbug-ohjelmalla ilmoitetaan Debianissa ilmenevästä viasta

Suosittelemme että Debianin vikailmoitukset tehdään reportbug-ohjelman avulla. Se asennetaan ja käynnistetään näin:

# aptitude install reportbug
$ reportbug

Ohjelma helpottaa vikailmoitusten tekemistä opastamalla askel askeleelta vikailmoituksen laatimisessa.

Jos vastaan tulee kysymyksiä, joihin ei reportbugin avulla löydy vastauksia, voit etsiä tietoja tästä dokumentista tai kysyä neuvoja Debian-käyttäjien postilistalta.

Vikailmoitusten lähettäminen sähköpostitse (sekä reportbugin edistyneempi käyttö)

Tärkeitä huomioita ennen vikailmoituksen lähettämistä

Mitä pakettia vikailmoitus koskee?

Selvitä, mistä paketista vikailmoitus tulee tehdä. Katso tästä esimerkistä kuinka tarvittavat tiedot saa selville. (Käytä näitä tietoja tarkistaaksesi onko viasta tehty jo ilmoitus.)

Jos et pysty päättelemään, mistä paketista vikailmoitus pitäisi tehdä, lähetä sähköpostia Debianin käyttäjien postilistalle ja kysy neuvoa.

Jos ongelma ei liity ainoastaan yhteen pakettiin, vaan johonkin Debianin yleiseen palveluun, on näitä varten olemassa useita pseudopaketteja ja jopa postilistoja, joita voi käyttää ilmoituksen välittämiseen meille.

Onko viasta tehty jo ilmoitus?

Tarkista ennen ilmoitusta ettei kukaan muu ole jo ilmoittanut samasta viasta. Paketin avoimia vikailmoituksia voi etsiä vikailmoitushaun pakettivalinnan avulla. Kommentit jo olemassa oleviin vikailmoituksiin #<numero> voi lähettää sähköpostitse osoitteeseen <numero>@bugs.debian.org.

Lähetä jokaisesta viasta oma ilmoituksensa

Älä ilmoita useammasta toisiinsa liittymättömästä ongelmasta — erityisesti eri paketeissa — yhdessä viestissä.

Ei vikailmoituksia alkuperäisen koodin ylläpitäjälle

Kun teet Debianiin liittyvän vikailmoituksen, älä lähetä ilmoituksesta kopiota alkuperäisen koodin ylläpitäjälle, sillä on mahdollista että vika esiintyy vain Debianissa. Debian-paketin ylläpitäjä lähettää tarvittaessa vikailmoituksen edelleen koodin alkuperäiselle ylläpitäjälle.

Vikailmoitusten lähettäminen sähköpostitse

Lähetä alla olevien ohjeiden mukainen englanninkielinen sähköposti osoitteeseen submit@bugs.debian.org. reportbug (kts. yllä) muotoilee viestit oikein puolestasi; käytä mieluummin sitä!

Otsakkeet

Kuten kaikissa sähköposteissa, Aihe-otsakkeen (Subject) pitäisi olla selkeä ja kuvaava viestisi pääotsakkeissa. Antamasi aihe otetaan vian otsikoksi seurantajärjestelmään, joten yritä tehdä siitä mahdollisimman informatiivinen!

Ole ystävällinen ja käytä toista tapaa, joka on selostettu alempana, lähettäessäsi vikailmoituksesi muillekin vastaanottajille (kuten postilistoille), älä käytä siis tavallisia sähköpostiotsakkeita.

Pseudo-otsakkeet

Vikailmoituksen ensimmäisiä osia ovat pseudo-otsakkeet, jotka sisältävät tiedot vikailmoitusta koskevasta paketista ja sen versiosta. Pseudo-otsakkeen tulee olla viestin ensimmäisellä rivillä, alla esimerkki:

Package: <paketin nimi>

Korvaa <paketin nimi> sen paketin nimellä, josta vika on löytynyt.

Viestin toisen rivin pitäisi olla seuraavanlainen:

Version: <paketin versio>

Korvaa <paketin versio> käyttämäsi paketin versionumerolla. Laita tähän kohtaan ainoastaan versionumero (ei muuta tekstiä), sillä vianseurantajärjestelmä käyttää tätä kenttää selvittäessään mitkä julkaisut ovat alttiita ilmoitettavalle vialle.

Pseudo-otsakkeen Package-rivin täytyy olla kelvollinen, jotta vianseurantajärjestelmä osaa välittää viestin paketin ylläpitäjälle. Katso tästä esimerkistä kuinka löydät kyseisen tiedon.

Muut käytettävissä olevat pseudo-otsakkeet löytyvät kohdasta Muut pseudo-otsakkeet

Ilmoituksen runko

Sisällytä nämä asiat ilmoitukseen:

Kerro myös kaikki yksityiskohdat, jotka tuntuvat oleellisilta — liian pitkän, ylimääräistä tietoa sisältävän vikailmoituksen tekemisestä ei ole haittaa. Sisällytä myös kaikki tiedostot, joita käytit ongelman toistamiseen (jos tiedostot ovat suurikokoisia, laita ne julkisesti saataville jollekin www-sivustolle mikäli mahdollista).

Lisätietoja siitä, kuinka auttaa kehittäjiä ongelmien ratkaisussa, saa lukemalla dokumentin How to Report Bugs Effectively.

Esimerkki vikailmoituksesta

Vikailmoitus otsakkeen ja pseudo-otsakkeen kera näyttää jotakuinkin tältä:

  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.

Vikailmoituksien kopioiminen muihin osoitteisiin

Joskus on tarpeen lähettää kopio vikailmoituksesta muuallekin kuin debian-bugs-dist-listalle ja paketin ylläpitäjälle, minne kopiot yleensä lähetetään.

Tämän voi tehdä lähettämällä kopion (Cc:) vikailmoituksesta muihin osoitteisiin, mutta silloin kopiot eivät sisältäisi vikailmoituksen numeroa Reply-To- ja Subject-otsakkeissa. Sen jälkeen kun vastaanottaja vastaa viestiin, hän luultavasti vastaa myös submit@bugs.debian.org-osoitteeseen ja hänen viestinsä kirjataan uudeksi vikailmoitukseksi. Tämä johtaa moniin ilmoituksen kaksoiskappaleisiin.

Oikea tapa lähettää kopioita on käyttää X-Debbugs-CC-otsaketta. Lisää alla olevan tapainen rivi viestin postiotsakkeisiin:

 X-Debbugs-CC: muu-lista@huitsinnevada.fi.invalid

Näin vianseurantajärjestelmä lähettää ilmoituksesta kopion X-Debbugs-CC-rivillä annettuihin osoitteisiin samoin kuin debian-bugs-dist-listalle.

Vältä tällaisten kopioiden lähettämistä muihin vikailmoitusosoitteisiin, koska ne jäävät kiinni postisilmukoiden estämiseksi tehtävissä tarkistuksissa. X-Debbugs-CC-otsakkeen käyttö tähän tarkoitukseen ei ole muutenkaan kovin mielekästä, koska kyseisen mekanismin lisäämä vikanumero korvataan uudella; käytä sen sijaan tavallista CC-otsaketta.

Tämä ominaisuus voidaan hyödyllisesti yhdistää osoitteen quiet kanssa — katso alla.

Muut pseudo-otsakkeet

Vakavuusasteet

Jos ilmoitus koskee erittäin vakavaa vikaa tai on vain ehdotus uudesta ominaisuudesta, voi ilmoituksessa asettaa vialle vakavuusasteen. Tätä ei kuitenkaan vaadita, kehittäjä asettaa sopivan vakavuusasteen jos sitä ei ole tehty (tai on valittu virheellinen vakavuusaste).

Asettaaksesi vakavuusasteen, lisää seuraavan kaltainen rivi pseudo-otsakkeeseen:

Severity: <vakavuus>

Korvaa <vakavuus> jollakin käytössä olevalla vakavuusasteella, kuten kehittäjien ohjeissa on kuvattu.

Tagien käyttäminen

Ilmoitettavalle vialle voi asettaa erinäisiä tageja. Esimerkiksi, jos vikaraporttiin liitetään korjaus, asetetaan patch-tagi. Tätä ei kuitenkaan vaadita, ja kehittäjät kyllä asettavat tagit raporttiin kun ja jos se on tarpeen.

Tagi asetetaan laittamalla pseudo-otsakkeeseen alla olevan kaltainen rivi:

Tags: <tagit>

Korvaa <tagit> yhdellä tai useammalla käytettävissä olevalla tagilla, ne on kuvailtu kehittäjän dokumenteissa. Erota useampi tagi toisistaan pilkuilla, välilyonneillä tai molemmilla.

User: <käyttäjätunnus>
Usertags: <käyttäjätagit>

Korvaa <käyttäjätagit> yhdellä tai useammalla käyttäjätagilla. Erota useampi tagi toisistaan pilkuilla, välilyonneillä tai molemmilla. Jos <käyttäjätunnus> määritetään, asetetaan kyseisen käyttäjän tagit. Muussa tapauksessa lähettäjän sähköpostiosoite laitetaan käyttäjätunnukseksi.

Edelleenohjatuksi merkitseminen

Forwarded: foo@esimerkki.fi.invalid

merkitsee lähetetyn vikailmoituksen edelleenohjatuksi osoitteeseen foo@esimerkki.fi.invalid. Katso yksityiskohdat kehittäjien dokumentaatiossa kappaleesta Vikailmoituksen välittämisen merkitseminen.

Omistajuuden ottaminen

Owner: foo@esimerkki.fi.invalid

merkitsee, että foo@esimerkki.fi on nyt vastuussa tämän vian korjaamisesta. Katso yksityiskohdat kehittäjien dokumentaatiossa kappaleesta Vian omistajan vaihtaminen.

Lähdekoodipaketti

Source: foopaketti

on sama kuin Package: vioille, jotka ovat lähdekoodipaketissa foopaketti; yleensä useimpien pakettien vioissa et halua käyttää tätä.

Hallintakomennot

Control: hallintakomennot

Mahdollistaa minkä tahansa komennon, joka täytyy lähettää osoitteeseen control@bugs.debian.org, toiminnan kun se lähetetään osoitteeseen submit@bugs.debian.org tai nnn@bugs.debian.org. Katso palvelimen hallintaohjeista lisätietoa mitkä hallintakomennot kelpaavat.

X-Debbugs-otsakkeet

Lisäksi vielä mikäli MUA ei salli otsakkeiden muokkaamista, voit asettaa erilaisia X-Debbugs-otsakkeita pseudo-otsakkeisiin.

Lisätietoja

Eri lähetysosoitteet (vähäpätöiset tai massailmoitukset)

Jos ilmoitettava vika on pieni, esimerkiksi kirjoitusvirhe dokumentaatiossa tai merkityksetön käännösongelma, asetetaan vakavuusaste sen mukaisesti ja lähetetään ilmoitus osoitteeseen maintonly@bugs.debian.org submit@bugs.debian.org:n sijaan. maintonly välittää ilmoituksen ainoastaan ylläpitäjälle, sitä ei välitetä BTS:n postilistalle.

Jos lähetetään useita ilmoituksia kerralla, pitää todellakin käyttää osoitetta maintonly@bugs.debian.org, jotta ei aiheuta liiallista liikennettä BTS:n postilistalla. Ennen kuin lähetetään ilmoituksia useista samankaltaisista vioista, halutaan kenties lähettää tiivistelmä listalle debian-bugs-dist.

Jos halutaan ilmoittaa sellaisesta viasta seurantajärjestelmään, joka on jo ilmoitettu ylläpitäjälle, voidaan käyttää osoitetta quiet@bugs.debian.org. Tähän osoitteeseen lähetettyjä viestejä ei välitetä minnekään, ainoastaan tallennetaan.

Kun käytetään eri lähetysosoitteita, vianseurantajärjestelmä asettaa edelleenlähetettyjen postien Reply-To-osoitteen samaksi kuin alkuperäisessäkin ilmoituksessa, jolloin vastaukset käsitellään samalla tavalla kuin alkuperäinenkin. Tämä tarkoittaa, että esimerkiksi vastaukset maintonly-viesteihin menevät osoitteeseen nnn-maintonly@bugs.debian.org nnn@bugs.debian.org-osoitteen sijaan ellei lähettäjä muuta tätä käsin.

Ilmoitus vikaraportin vastaanotosta

Normaalisti vianseurantajärjestelmä palauttaa sähköpostitse ilmoituksen vastaanotetusta vikailmoituksesta tai aiemmin ilmoitettua vikaa koskevien lisätietojen toimituksesta. Mikäli tätä ilmoitusta ei haluta, tulee viestiin sisällyttää X-Debbugs-No-Ack-otsake tai -pseudo-otsake (otsakkeen sisällöllä ei ole merkitystä). Mikäli tässä otsakkeessa ilmoitetaan uudesta viasta, on vian numero selvitettävä itse www-liittymän kautta.

Huomaa että tämä otsake ei vaikuta control@bugs.debian.org-postipalvelimen lähettämiin ilmoituksiin, sillä kyseiset ilmoitukset saattavat sisältää virheilmoituksia, jotka tulisi lukea ja toimia niiden mukaisesti.

Taistelu roskapostia vastaan ja kadonneet postit

Vianseurantajärjestelmä käyttää roskapostin suodatukseen verraten laajoja sääntökokoelmia. Väärien hälytysten määrä pyritään minimoimaan, mutta toisinaan niitä kuitenkin ilmenee. Jos epäilet että postisi on aiheuttanut väärän hälytyksen, pyydä lisäohjeita osoitteesta owner@bugs.debian.org. Toinen yleinen syy joka estää postin pääsyn vianseurantajärjestelmään on sellaisten osoitteiden käyttö jotka täsmäävät procmailin FROM_DAEMON-säännön kanssa. Tällaisia ovat esim. lähdeosoitteen mail@foobar.com kaltaiset osoitteet. Mikäli epäilet että osoitteesi täsmää FROM_DAEMON-säännön kanssa, tarkista asia man-sivulta procmailrc(5) ja lähetä posti sen jälkeen uudelleen käyttämällä osoitetta joka ei täsmää FROM_DAEMON-säännön kanssa.

Tuntemattomissa paketeissa olevista vioista ilmoittaminen

Jos vianseurantajärjestelmä ei löydä paketille ylläpitäjää, ohjataan ilmoitus debian-bugs-dist-listalle vaikka maintonly olisikin ollut käytössä.

Kun lähetetään ilmoitus osoitteeseen maintonly@bugs.debian.org tai nnn-maintonly@bugs.debian.org, tulee varmistaa, että vikailmoitus on osoitettu oikealle paketille asettamalla oikea Package-koodi alkuperäisen ilmoitusviestin alkuun tai (uudelleen)osoittamalla ilmoitus control@bugs.debian.org-palvelua käyttäen oikealle paketille jos näin ei vielä ole.

dpkg:n käyttö paketin ja version löytämiseksi ilmoitukseen

Käytettäessä reportbugia jossain komennossa ilmenneen vian ilmoitukseen, esim. grep, seuraava valitsee automaattisesti oikean paketin ja pääset kirjoittamaan ilmoitusta välittömästi: reportbug --file $(which grep)

Voit myös selvittää lähdepaketin komennolla dpkg --search. Asennetun paketin versionumeron saa selville komennolla dpkg --list tai dpkg --status.

Esimerkiksi:

$ 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

Muita hyödyllisiä komentoja ja paketteja

querybts-työkalu, joka löytyy samasta paketista kuin reportbug, tarjoaa kätevän tekstipohjaisen käyttöliittymän vianseurantajärjestelmään.

Emacs-käyttäjät voivat käyttää myös debian-el-paketin mukana tulevaa debian-bug-komentoa. Komentoa kutsutaan näppäilemällä M-x debian-bug ja se kysyy tarvittavat tiedot samalla tavoin kuin reportbug.


BTS:n muut sivut:


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.