Бележка: Оригиналният документ има по-нова версия от този превод.

Как да съобщим за открит бъг в Debian, използвайки reportbug системата

Силно препоръчваме да съобщавате за откритите от вас бъгове в Debian чрез програмата reportbug. Просто изпълнете командата aptitude install reportbug; reportbug, за да инсталирате и стартирате reportbug. Програмата ще ви преведе през целия процес на събщаване за открит бъг стъпка по стъпка.

Ако имате въпроси, които интерактивната система на reportbug не успява да отговори, можете да се консултирате с тази документация или да попитате в Debian потребителския пощенски списък.

Как да съобщим за открит бъг в Debian, използвайки email (и задълбочено използване на reportbug)

Важни неща, които трябва да изнясните преди да изпратите вашия доклад за открит бъг

За кой пакет се отнася доклада за открит бъг?

Трябва да знаете за кой пакет се отнася бъга, който се открили. Вижте този пример за това как да откриете тази информация. (Можете да използвате тази информация за да видите дали вашия доклад за октрит бъг не е вече докладван.)

Ако не можете да определите кой пакет е отговорен за проблема, моля, изпратете e-mail до пощенския списък за потребители на Debian, съдържащ въпроса Ви.

Ако Вашият проблем не се отнася само за един пакет, а за някоя основна Debian услуга, съществуват няколко псевдо-пакета (pseudo-packages) както и пощенски списъци, които можете да ползвате, за да препратите съобщението си до нас.

Дали не е бил вече изпратен доклад като вашия?

Хубаво е да проверите дали все пак някой не е изпратил вече доклад за открит бъг подобен на вашия, преди да изпратите своя. Можете да видите списък с бъговете за даден пакет като използвате опцията за търсене по пакет в формата за търсене на бъгове. Ако съществува вече такъв доклад с #<номер>, трябва да изпратите коментар като изпратите e-mail на <номер>@bugs.debian.org вместо да изпращате нов доклад за този бъг.

Изпращане на множество доклади за множество бъгове

Моля не изпращайте доклади за повече от един несвързани помежду си бъгове — особено такива от различни пакети — в един доклад.

Не изпращайте доклади за грешки на оригиналните автори

Ако изпращате доклад за открит бъг в Debian, моля не изпращайте копие до оригиналния автор на програмата, тъй като е възможно този бъг да съществува само в Debian. Ако е нужно, мениджъра на пакета ще препрати бъг рапорта към автора на софтуерната програма.

Изпращане на съобщението за открит бъг чрез e-mail

Изпратете e-mail до submit@bugs.debian.org, в специален формат както е описано по-долу.reportbug (виж по-горе) ще форматира правилно писмата Ви автоматично; моля използвайте го!

Заглавия (Headers)

Разбира се, както при всеки e-mail трябва да включите ясен, описателен Subject ред в заглавния Ви хедър на писмото. Темата (subject), която ще дадете, ще бъде използвана като начално заглавие на бъга в системата за следене, така че, моля, опитайте се да я направите информативена!

Ако желаете да изпратите копие на вашия доклад за открит бъг към други получатели (като пощенски списъци), не използвайте стандартните e-mail заглавия (headers), а различен метод описан по-долу.

Псеведо-заглавия

Първата част на доклада за открит бъг е псвевдо-заглавието (pseudo-header), който съдържа информация за това какъв пакет и коя версия е насочен този доклад. Псевдо-заглавието трябва да е разположено на първия ред на тялото (body) на съобщението. С други думи, първия ред на тялото на съобщението трябва да е подобно на:

Package: <име на пакет>

Заместете <име на пакета> с името на пакета, в който има бъг.

Вторият ред на съобщението трябва да бъде:

Version: <версия на пакета>

Заместете <версия на пакета> с версията на пакета. Моля не включвайте друг текст освен номера на версията, тъй като системата за следене на бъгове разчита именно на това поле, за да разбере за коя точно версия се отнася бъга.

Трябва да сложите правилен Package ред в псевдо хедъра, за да може системата за следене на бъгове да достави съобщението на мениджъра на пакета. Погледнете този пример за информация относно как да откриете тази информация.

За други валидни псевдо-заглавия, вижте Допълнителнои псевдо-заглавия

Тялото на доклада

Моля, включете в доклада си:

Включете всякаква информация, които смятате за уместна — малка е опасността да направите доклада си твърде дълъг като включите прекалено много информация. Ако са малки, моля, вклчете в съобщението си всякакви файлове, които сте използвали, за да се възпроизведе проблема (кодирайте ги (uuencoding), ако съдържат нестандартни символи и др.).

За повече съвети, отностно това как можете да помогнете на програмистите да решат вашия проблем, моля прочетете документа Как да докладваме за бъгове ефективно.

Примерен доклад за открит бъг

Съобщение за бъг; с хедър на писмото; изглежда така:

  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.

Изпращане на копие на съобщението за бъг до други адреси

Понякога е нужно да се изпрати копие на доклад за открит бъг до някаде другаде освен debian-bugs-dist и мениджъра на пакета, където обикновено биват изпращани.

Можете да направите това като изпратите съобщението си за открит бъг на друг(и) адрес(и) (чрез CC полето), но тогава другите копия няма да имат номера на бъг-доклада в Reply-To полето и Subject реда. Когато получателите отговорят, вероятно ще запазят submit@bugs.debian.org частта в хедъра и така съобщението ще бъде записано като нов бъг-доклад. Това води до множество дублиращи се съобщения.

Правилният начин да направите това е като използвате X-Debbugs-CC хедър. Добавете такъв ред в хедъра на писмото:

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

Това ще накара системата за следене на бъгове да изпрати копие на Вашия доклад до адрес(а/ите) в X-Debbugs-CC реда, както и до debian-bugs-dist.

Внимавайте при такова изпращане на копия към адреси за други доклади за бъгове, за да не се получават циклични изпращания на писма от една група към друга и обратното. Освен това използването на X-Debbugs-CC се обезмисля също и от факта, че номера на бъга, който се добавя от механизма ще бъде заменен от по-новия, затова по-добре изполвайте обикновения начин - чрез CC в писмото.

Тази функция може често да бъде пълноценно комбинирана с дискретно изпращане на писмо — погледнете по-долу.

Допълнителни псевдо-заглавия

Ниво на срещаемост

Ако докладът е за сравнително сериозен бъг или просто молба за въвеждане на функция, можете да определите нивото на срещаемост на бъга докато го съобщавате. Това не е изискване, но програмистите ще зададат подходящо ниво на съобщението Ви, ако Вие не го направите.

За да зададете ниво на срещаемост сложете ред като този в псевдо-хедъра (pseudo-header):

Severity: <срещаемост>

Заместете <срещаемост> с едно от възможните нива, както е описано в документацията за програмисти.

Задаване на тагове (tags)

Можете да поставите тагове в съобщението за открит бъг. Например, ако включвате и кръпка във Вашия бъг-доклад, може да зададете patch тага. Това не е задължително, но програмистите ще зададат тагове на Вашия доклад когато и ако е уместно.

За да поставите тагове въведете ред като описания по-долу в псевдо-хедъра (pseudo-header):

Tags: <тагове>

Заместете <тагове> с един или повече от възможните тагове, както е описано в документацията за програмисти. Разделяйте поредицата от тагове чрез запетайки, интервали или и двете.

User: <потребителско име>
Usertags: <потребителски тагове>

Заместете <потребителски тагове> с един или повече потребителски дефинирани тагове. Разделяйте поредицата от тагове чрез запетайки, интервали или и двете. Ако зададете <потребителско име>, ще бъдат зададени тези потребителски тагове. В противен случай, e-mail адреса на изпращача ще бъде използван за потребителско име.

Forwarded: foo@example.com

ще маркира новоизпратения бъг като препратен (forwarded) към foo@example.com. За повече информация прочетете Запис на бъг рапорта в документацията за разработчици.

Owner: foo@example.com

показва, че foo@example.com вече е новия отговорник (owner) за поправянето на бъга. За повече информация прочетете Промяна на собственик на бъг в документацията за разработчици.

Source: foopackage

е еквивалентно на Package: за бъгове, налични и в сорс (source) пакета на foopackage; за повечето бъгове в повечето пакети, тази опция не е нужна.

И най-накрая, ако вашия MUA не разрешава редакцията на хедъри, можете зададете различни X-Debbugs- хедъри в pseudo-headers.

Допълнителна информация

Различни подчинени адреси (маловажни или масивни бъг-доклади)

Ако съобщение за бъг е маловажно, например, нещо свързано с документацията или тривиален проблем при компилацията, моля, настройте уместно ниво на срещаемост и изпратете съобщението до maintonly@bugs.debian.org вместо на submit@bugs.debian.org. maintonly ще препрати доклада само към мениджъра на пакета, няма да го препрати към BTS пощенските списъци.

Ако изпращате много съобщения наведнъж със сигурност трябва да използвате maintonly@bugs.debian.org, така че да не предизвикате прекалено излишен трафик в BTS пощенските списъци. Преди да изпратите съобщения за множество подобни бъгове, можете да пуснете резюме в debian-bugs-dist.

Ако желаете да съобщите за бъг в системата за следене на бъгове, който вече е изпратен до мениджъра, можете да използвате quiet@bugs.debian.org. Бъгове изратени до quiet@bugs.debian.org няма да бъдат препращани никаде, а ще бъдат само записвани.

Когато използвате различни подчинени адреси, системата за бъгове ще настрой Reply-To на всички препратени съобщения, така че отговорите по подразбиране да бъдат обработвани по същия начин както първоначалния доклад. Това означава, че, например, отговорите до maintonly ще отидат при nnn-maintonly@bugs.debian.org вместо при nnn@bugs.debian.org, освен ако някой не пренастрой това ръчно.

Съобщения за открити бъгове в неизвестни пакети

Ако системата за следене на бъгове не знае кой е мениджъра на съответния пакет, то тя ще препрати съобщението към debian-bugs-dist дори и да е зададен като maintonly.

Когато изпращате до maintonly@bugs.debian.org или nnn-maintonly@bugs.debian.org трябва да сте сигурни, че съобщението за бъг е предназначено за правилия пакет, като поставите точния Package в началото на първоначално представения доклад или като използвате control@bugs.debian.org услугата, за да определите доклада правилно, ако не е верен.

Използване на dpkg за намиране на пакета и версията на доклада

Когато използвате reportbug, за да докладвате за бъг в команда, например grep, следващия ред автоматично ще избере правилния пакет и ще Ви даде възможност да напишете за проблема си веднага: reportbug --file $(which grep)

Можете също така да откриете кой пакет е бил инсталиран като използвате командата dpkg --search. Можете да разберете коя версия на пакета имате инсталирана като въведете dpkg --list или dpkg --status.

Например:

$ 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

Други полезни команди и пакети

Инструментът querybts, наличен от същия пакет като reportbug, предлага удобен текстово базиран интерфейс към системата за следене на бъгове.

Потребителите на Emacs също може да използват debian-bug командата, налична в debian-el пакета. Когато бъде извикана с M-x debian-bug, ще бъдете запитани за всичката необходима информация по подобен начин като reportbug.


Други BTS страници:


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.