Съобщаване за открита грешка в Дебиан с reportbug

Силно препоръчваме да съобщавате за откритите от вас грешки в Дебиан чрез програмата reportbug. За да инсталирате reportbug, просто изпълнете командата:

# aptitude install reportbug
$ reportbug

Програмата ще ви преведе през целия процес на събщаване за грешката.

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

Съобщаване за открита грешка в Дебиан по електронна поща (и reportbug за напреднали)

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

В кой пакет е грешката?

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

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

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

Дали за грешката вече е съобщено?

Преди да изпратите доклада за грешката е добре да проверите дали вече е съобщено за подобна грешка. Всички грешки, за които е съобщено в даден пакет можете да видите чрез полето за филтриране по пакет на формуляра за търсене на доклади за грешки. подобна Ако за грешката вече е съобщено под #<номер>, изпратете съобщението до <номер>@bugs.debian.org, вместо да създавате нов доклад.

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

Не изпращайте доклади за несвързани помежду си грешки (особено такива от различни пакети) в един доклад.

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

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

Изпращане на доклад за грешка по e-mail

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

Заглавки

Разбира се, както при всяко съобщение, трябва да укажете ясена, описателна тема (Subject) в заглавките на писмото. Темата (subject) ще бъде използвана като начално заглавие на доклада за грешката в системата за следене, опитайте се да я направите съдържателна.

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

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

Първата част на съобщението съдържа псвевдо-заглавки, които съдържат информация за това за кой пакет и версия е доклада. Псевдо-заглавията трябва да започват от първия ред на съобщението. Например:

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

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

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

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

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

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

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

Текст на доклада

Включете в доклада си:

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

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

Примерен доклад за грешка

Доклад за грешка със заглавки и превдо-заглавки изглежда подобно:

  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 заглавка.

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

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

Степени на критичност

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

За да отбележите критичността на грешката добавете следния ред в псевдо-заглавките:

Severity: <критичност>

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

Присвояване на етикети

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

За да поставите етикети добавете долния ред в псевдо-заглавките:

Tags: <етикети>

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

User: <потребител>
Usertags: <потребителски етикети>

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

Отбелязване на препратени доклади

Forwarded: foo@example.com

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

Поемане на отговорност

Owner: foo@example.com

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

Указване на пакет-източник

Source: foopackage

е равносилно на Package: за грешки, намиращи се в пакета-източник на foopackage. Използването на тази псевдо-заглавка рядко е необходимо.

Вградени команди

Control: команди

Позволява използването на всички команди, поддържани от адреса control@bugs.debian.org при използване на submit@bugs.debian.org или nnn@bugs.debian.org. За означаване на текущия доклад (този, създаван с писмото до submit@ или докладът, до който се изпраща допълнителна информация на nnn@) може да използвате „-1“. Вижте страницита за управляващите команди за повече информация.

Например, следните псевдо-заглавки в съобщение, изпратено до 12345@bugs.debian.org:

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

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

Заглавки от вида X-Debbugs-нещо

И най-накрая, ако вашата пощенска програма не позволява промяната на заглавките, можете зададете различни заглавки X-Debbugs- като псевдо-заглавки.

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

Различни адреси за изпращане на докладите (за маловажни грешки или грешки, касаещи много пакети)

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

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

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

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

Потвърждения

Обикновено системата за следене на грешките връща потвърждения при подаване на доклад за нова грешка или изпращане на допълнителна информация към съществуващ доклад. Ако искате да потиснете потвържденията, добавете заглавка или псевдо-заглавка X-Debbugs-No-Ack в изпращаното съобщение. Ако използвате тази заглавка при докладване на нова грешка ще се наложи да проверите за номера на доклата в уеб-страницата на системата за следене на грешките.

Тази заглавка няма да потисне потвържденията от контролния адрес control@bugs.debian.org, защото тези потвърждения може да съдържат съобщения за грешки, на които да трябва да се реагира.

Борба с нежелатана поща и липсващи съобщения

Системата за следене на грешките използва обширна система от правила, проектирани да спрат нежеланата поща. Въпреки усилията, понякога нормални съобщения са считани за нежелана поща. Ако подозирате, че ваше съобщение е погрешно разпознато като нежелана поща, пишете до owner@bugs.debian.org за помощ. Друга честа причина за липсващи съобщения е използването на адреси, които съвпадат със списъка на procmail FROM_DAEMON, който включва адреси от вида mail@foobar.com. Ако подозирате, че вашият адрес е спрян поради тази причина, проверете procmailrc(5) и изпратете съобщението наново, от адрес, който не е сред адресите във FROM_DAEMON.

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

Ако системата за следене на грешките не разпознава кой е отговорника на съответния пакет, съобщението ще бъде препратено към 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.


Други страници за системата за следене на грешки:


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.