- nothing but formatting was changed

Approved by: maxim (mentor), marck (mentor)
This commit is contained in:
Taras Korenko 2010-07-09 20:24:59 +00:00
parent 3327e167d3
commit d4455f574f
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=35985

View file

@ -88,28 +88,29 @@
деле вы неправильно поняли синтаксис команды или сделали опечатку в
конфигурационном файле (хотя само по себе это иногда говорит о плохой
документации или неправильной обработке ошибок в прикладной программе).
Есть еще много случаев, когда посылка сообщения о проблеме явно <emphasis>не</emphasis>
является правильным действием, а только приводит к разочарованию вас и
разработчиков. И наоборот, есть случаи, когда может быть нужно послать
сообщение о чем-то, не являющемся ошибкой&mdash;к примеру, запрос на
доработку или расширение функциональности.</para>
Есть еще много случаев, когда посылка сообщения о проблеме явно
<emphasis>не</emphasis> является правильным действием, а только
приводит к разочарованию вас и разработчиков. И наоборот, есть случаи,
когда может быть нужно послать сообщение о чем-то, не являющемся
ошибкой&mdash;к примеру, запрос на доработку или расширение
функциональности.</para>
<para>Но как же определить, что является ошибкой, а что нет? Простым
правилом, которому нужно следовать, является следующее &ndash; ваша проблема
<emphasis>не</emphasis> является ошибкой, если она формулируется как
вопрос (обычно в форме <quote>Как сделать X?</quote> или <quote>Где можно
найти Y?</quote>). Не всегда это так однозначно, но правило вопроса
покрывает большинство случаев. Если Вам нужен ответ, лучше всего задать
свой вопрос в &a.questions;.</para>
правилом, которому нужно следовать, является следующее &ndash; ваша
проблема <emphasis>не</emphasis> является ошибкой, если она формулируется
как вопрос (обычно в форме <quote>Как сделать X?</quote> или <quote>Где
можно найти Y?</quote>). Не всегда это так однозначно, но правило
вопроса покрывает большинство случаев. Если Вам нужен ответ, лучше всего
задать свой вопрос в &a.questions;.</para>
<para>Вот некоторые случаи, в которых может оказаться полезным отправить
сообщение о чем-то, что не является ошибкой:</para>
<itemizedlist>
<listitem>
<para>Запросы на расширение функциональности. Обычно хорошей идеей является
озвучивание этого в списках рассылки до того, как посылать сообщение
о проблеме.</para>
<para>Запросы на расширение функциональности. Обычно хорошей идеей
является озвучивание этого в списках рассылки до того, как посылать
сообщение о проблеме.</para>
</listitem>
<listitem>
@ -118,27 +119,27 @@
и компоненты базовой системы, разрабатываемые сторонними
организациями, такие, как BIND или различные утилиты GNU).</para>
<para>Для не поддерживаемых никем портов (переменная <makevar>MAINTAINER</makevar>
<para>Для не поддерживаемых никем портов (переменная
<makevar>MAINTAINER</makevar>
содержит <literal>ports@FreeBSD.org</literal>), такие уведомления о
обновлении будут замечены заинтересовавшимся коммиттером и вас
могут попросить предоставить патч для обновления порта; предоставление патча
до того, как вас попросят об этом сильно увеличит шансы того,
обновлении будут замечены заинтересовавшимся коммиттером и вас могут
попросить предоставить патч для обновления порта; предоставление
патча до того, как вас попросят об этом сильно увеличит шансы того,
что порт будет обновлён вовремя.</para>
<para>Если порт поддерживается, PR-ы, указывающие о появлении новых
улучшенных (upstream) релизов обычно не очень полезны, так как они
прибавляют много вспомогательной работы для коммиттеров, а мэйнтейнер
наверняка уже знает о новой версии. Они уже наверняка работали с
разработчиками над ней или они возможно тестируют её, чтобы убедиться
в отсутствии регрессии и т.п.</para>
<para>В любом случае, следование процессу, описанному в <ulink
url="&url.books.porters-handbook;/port-upgrading.html">Руководстве по
созданию портов</ulink> даст наилучшие результаты.
(Также можно ознакомиться с статьей <ulink
url="&url.articles.contributing-ports;/article.html">
Контрибуция в коллекцию портов FreeBSD</ulink>.)</para>
</listitem>
</itemizedlist>
@ -178,10 +179,10 @@
разработчикам, если проблемы не являются специфичными
для &os;. Обычно ошибки такого рода попадают под
категории <literal>bin</literal> или <literal>gnu</literal>.</para>
</listitem>
</listitem>
<listitem>
<para>Отдельные приложения, не входящие в базовую систему,
<listitem>
<para>Отдельные приложения, не входящие в базовую систему,
но являющиеся частью Коллекции Портов &os; (категория
<literal>ports</literal>). Большинство этих приложений
не пишется разработчиками &os;; что предоставляет &os;,
@ -199,9 +200,9 @@
<para>Если проблема в базовой системе, то вам нужно сначала прочесть
раздел <ulink
url="&url.books.faq;/introduction.html#LATEST-VERSION">версии &os;</ulink>
из FAQ, если вы ещё не знакомы с данной темой. Для &os; возможно
исправлять проблемы только для некоторых недавних веток базовой
url="&url.books.faq;/introduction.html#LATEST-VERSION">версии
&os;</ulink> из FAQ, если вы ещё не знакомы с данной темой. Для &os;
возможно исправлять проблемы только для некоторых недавних веток базовой
системы, поэтому отправка сообщения об ошибке для более старой версии
приведёт к тому, что разработчик посоветует вам обновиться до
поддерживаемой версии, чтобы посмотреть присутствует ли в ней
@ -216,7 +217,6 @@
является поддержка чего-либо, кроме самых последних версий, и
проблемы со устаревшими версиями приложений просто не могут
быть исправлены.</para>
</section>
<section id="pr-prep">
@ -269,20 +269,20 @@
<ulink url="http://www.FreeBSD.org/cgi/query-pr-summary.cgi?query">
база данных PR &os;</ulink> (GNATS). Если только ваша проблема не
нова или редка, есть некоторый шанс, что о ней уже сообщено.</para>
</listitem>
</listitem>
<listitem>
<para>И самое важное, вы должны посмотреть не затрагивает ли
документация в базовой системе вашу проблему.</para>
<para>Для основного кода &os; вы должны тщательно изучить содержимое
файла <filename>/usr/src/UPDATING</filename> или его текущую версию
по адресу
<ulink url="http://www.FreeBSD.org/cgi/cvsweb.cgi/src/UPDATING"></ulink>.
по адресу <ulink
url="http://www.FreeBSD.org/cgi/cvsweb.cgi/src/UPDATING"></ulink>.
(Если вы переходите с одной версии на другую, особенно если вы
обновляетесь до &os.current;, то в этом файле вы можете найти много
важной информации).</para>
<para>Если же ваша проблема связана с коллекцией портов &os;, вы должны
обратиться к файлу <filename>/usr/ports/UPDATING</filename>
(изменения, касающиеся индивидуальных портов) или к
@ -290,8 +290,6 @@
коллекции портов). Они также доступны через интерфейс CVSweb: <ulink
url="http://www.FreeBSD.org/cgi/cvsweb.cgi/ports/UPDATING"></ulink> и
<ulink url="http://www.FreeBSD.org/cgi/cvsweb.cgi/ports/CHANGES"></ulink>.</para>
</listitem>
</itemizedlist>
</section>
@ -303,11 +301,12 @@
категорию сообщения о проблеме, и это проблема &os;, самое время
написать собственно сообщение о проблеме (PR). Прежде чем мы углубимся
в частности использования программы для создания и отправки PR, вот
несколько советов, которые помогут вам сделать PR более эффективным.
</para>
несколько советов, которые помогут вам сделать PR более
эффективным.</para>
<section>
<title>Как писать хорошие сообщения о проблемах</title>
<itemizedlist>
<!-- marck: RU-specific -->
<listitem>
@ -348,9 +347,9 @@
<para><emphasis>Если у вас есть готовый патч, скажите об
этом.</emphasis> PR, содержащий патч, имеет куда больше шансов
быть рассмотренным. В этом случае добавьте строку
<literal>[patch]</literal> (включая квадратные скобки) в начало поля <quote>Synopsis</quote>
(хотя использование именно этой формы необязательно, она является
стандартом де-факто).</para>
<literal>[patch]</literal> (включая квадратные скобки) в начало
поля <quote>Synopsis</quote> (хотя использование именно этой формы
необязательно, она является стандартом де-факто).</para>
</listitem>
<listitem>
@ -358,16 +357,16 @@
этом.</emphasis> Если вы отвечаете за часть исходных текстов
(например, порт), вы можете добавить в начало поля
<quote>Synopsis</quote> строку
<literal>[maintainer update]</literal> (включая квадратные скобки), а также установить класс
вашего PR (поле <quote>Class</quote>) в
<literal>[maintainer update]</literal> (включая квадратные скобки),
а также установить класс вашего PR (поле <quote>Class</quote>) в
<literal>maintainer-update</literal>. В этом случае коммиттеру,
обрабатывающему ваш PR, не придётся лишний раз проверять.</para>
</listitem>
<listitem>
<para><emphasis>Будьте точны в формулировках.</emphasis>
Чем больше информации вы можете предоставить о проблеме, тем больше
у вас шансов получить ответ.</para>
<para><emphasis>Будьте точны в формулировках.</emphasis> Чем больше
информации вы можете предоставить о проблеме, тем больше у вас
шансов получить ответ.</para>
<itemizedlist>
<listitem>
@ -376,10 +375,10 @@
и на какой архитектуре. Сообщите, используете ли вы release
версию (установили с компакт-диска либо загрузили) или скачали
её с помощью &man.cvsup.1; (если так, то как давно вы
обновлялись). Если вы используйте &os.current;, то первый вопрос,
который вам могут задать, будет про дату последнего обновления,
так как исправления для этой ветки имеют
тенденцию (особенно для серьёзных проблем) появляться слишком
обновлялись). Если вы используйте &os.current;, то первый
вопрос, который вам могут задать, будет про дату последнего
обновления, так как исправления для этой ветки имеют тенденцию
(особенно для серьёзных проблем) появляться слишком
быстро.</para>
</listitem>
@ -390,7 +389,7 @@
&man.gcc.1; во многих случаях может быть причиной ошибок. Хотя
и разработчики &os; будут принимать патчи, у них не будет
желания исследовать такие случаи из-за отсутствия времени и
добровольцев, и вместо этого они могут ответить, что это не
добровольцев, и вместо этого они могут ответить, что это не
поддерживается.</para>
</listitem>
@ -406,21 +405,23 @@
</listitem>
<listitem>
<para>Если ваша проблема связана с ядром, будьте готовы предоставить
следующую информацию (вам не обязательно включать её всю, она пойдёт лишь
на заполнение базы данных, но вы должны включить информацию,
которая по вашему мнению актуальна):</para>
<para>Если ваша проблема связана с ядром, будьте готовы
предоставить следующую информацию (вам не обязательно включать
её всю, она пойдёт лишь на заполнение базы данных, но вы должны
включить информацию, которая по вашему мнению актуальна):</para>
<itemizedlist>
<listitem>
<para>Вашу конфигурацию ядра, включая то, какие устройства у вас
установлены</para>
<para>Вашу конфигурацию ядра, включая то, какие устройства
у вас установлены</para>
</listitem>
<listitem>
<para>Включены ли у вас опции отладки (например,
<literal>WITNESS</literal>), и если так, то существует ли
проблема после изменения значения этой опции</para>
</listitem>
<listitem>
<para>Полный вывод обратной трассировки (backtrace),
паники или иного консольного вывода, или же записи из
@ -434,11 +435,13 @@
в случае, если проблема связана с конкретным
оборудованием</para>
</listitem>
<listitem>
<para>Прочли ли вы <filename>src/UPDATING</filename>, описана ли
там ваша проблема (кто-нибудь спросит обязательно)
</para>
<para>Прочли ли вы <filename>src/UPDATING</filename>,
описана ли там ваша проблема (кто-нибудь спросит
обязательно)</para>
</listitem>
<listitem>
<para>Запускается ли другое ядро (это для тех случаев,
когда причиной сбоя стало оборудование, например
@ -453,17 +456,19 @@
следующую информацию (вам не обязательно включать её всю,
она пойдет лишь на заполнение базы данных, но вы должны
включить информацию, которая по вашему мнению актуальна):</para>
<itemizedlist>
<listitem>
<para>Какие порты вы устанавливали</para>
</listitem>
<listitem>
<para>Имеются ли какие-либо переменные окружения,
которые переписывают первоначально-установленные
в <filename>bsd.port.mk</filename>, такие как,
<makevar>PORTSDIR</makevar>)</para>
</listitem>
<listitem>
<para>Прочли ли вы <filename>ports/UPDATING</filename>, и
описана ли там ваша проблема (кто-нибудь спросит
@ -471,10 +476,8 @@
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>
</listitem>
<listitem>
<para><emphasis>Избегайте нечетких запросов о новых
@ -535,17 +538,18 @@
<section>
<title>Прежде всего</title>
<para>Если вы используйте утилиту &man.send-pr.1; проверьте, что переменная
вашего окружения <envar>VISUAL</envar> (или <envar>EDITOR</envar>, если
<envar>VISUAL</envar> не задана) задана подходящим образом.</para>
<para>Если вы используйте утилиту &man.send-pr.1; проверьте, что
переменная вашего окружения <envar>VISUAL</envar> (или
<envar>EDITOR</envar>, если <envar>VISUAL</envar> не задана) задана
подходящим образом.</para>
<para>Следует также проверить работоспособность системы электронной
почты. Утилита &man.send-pr.1; использует почтовую систему для
отправки и отслеживания сообщения о проблеме. Если с машины, на
которой вы запускаете &man.send-pr.1;, нельзя отправить почту,
сообщение не попадёт в базу данных GNATS. О настройке электронной
почты во &os; можно прочитать в главе <quote>Электронная
почта</quote> Руководства по &os; по адресу <ulink
сообщение не попадёт в базу данных GNATS. О настройке электронной
почты во &os; можно прочитать в главе <quote>Электронная
почта</quote> Руководства по &os; по адресу <ulink
url="http://www.FreeBSD.org/doc/ru_RU.KOI8-R/books/handbook/mail.html"></ulink>.</para>
<para>Убедитесь, что ваш почтовый клиент не исказит сообщение по
@ -557,11 +561,10 @@
для читабельности PR на веб странице.</para>
<para>Примерные соображения должны учитываться при отправке
сообщения об ошибке через
<ulink url="&url.base;/send-pr.html">веб-форму</ulink>
вместо &man.send-pr.1;.
Помните, что операции копирования-вставки могут иметь
сторонние эффекты в форматировании текста. В определённых
сообщения об ошибке через <ulink
url="&url.base;/send-pr.html">веб-форму</ulink> вместо
&man.send-pr.1;. Помните, что операции копирования-вставки могут
иметь сторонние эффекты в форматировании текста. В определённых
случаях может быть необходимо использовать &man.uuencode.1;
для гарантии того, что патчи придут не изменёнными.</para>
@ -569,7 +572,6 @@
приготовить его в offline, чтобы ничего не потерялось в случае,
если будет проблема при его отправке. Это особенно касается <ulink
url="&url.base;/send-pr.html">веб-формы</ulink>.</para>
</section>
<section>
@ -611,16 +613,16 @@
Это выполнит экранирование (escaping) символов и весь патч
будет бесполезным.</para>
<para>Следует также заметить, что включение небольших патчей в сообщение о
проблеме является приемлемой практикой, в особенности если они решают
<para>Следует также заметить, что включение небольших патчей в сообщение
о проблеме является приемлемой практикой, в особенности если они решают
проблему, описанную в сообщении, большие же патчи, а в особенности
новый код, который может требовать значительного просмотра перед тем,
как он будет внесен в дерево исходных текстов, должны быть размещены на
web- или ftp-сервере, а в сообщение о проблеме должен быть включён
только URL указывающий на этот патч. Очень часто патчи, пересылаемые по
электронной почте, а в особенности если задействована GNATS, бывают
только URL указывающий на этот патч. Очень часто патчи, пересылаемые
по электронной почте, а в особенности если задействована GNATS, бывают
искажены, и, как следствие, чем больше патч, тем труднее будет для
заинтересованных людей привести его к нормальному виду. Также то, что
заинтересованных людей привести его к нормальному виду. Также то, что
патч будет размещён отдельно от сообщения о проблеме, даёт возможность
изменять его не отсылая полный патч в дополнение к изначальному
сообщению о проблеме. И наконец, большие патчи просто увеличивают
@ -641,12 +643,11 @@
PR через электронную почту:</para>
<para>После запуска утилиты &man.send-pr.1; вам будет представлен шаблон
сообщения о проблеме.
Шаблон состоит из списка полей, некоторые из которых уже заполнены,
а некоторые содержат комментарии, объясняющие назначение поля или
перечисляющие подходящие значения. Не беспокойтесь о комментариях; они
будут автоматически удалены, если вы их не изменяли (или удалите их
сами).</para>
сообщения о проблеме. Шаблон состоит из списка полей, некоторые из
которых уже заполнены, а некоторые содержат комментарии, объясняющие
назначение поля или перечисляющие подходящие значения. Не беспокойтесь
о комментариях; они будут автоматически удалены, если вы их не изменяли
(или удалите их сами).</para>
<para>Вверху шаблона, ниже строк <literal>SEND-PR:</literal> находятся
заголовки почтового сообщения. Вам обычно не нужно их изменять, если
@ -667,20 +668,19 @@
вы используете &os.stable;.</para>
</listitem>
<listitem>
<para><emphasis>Confidential:</emphasis> Предварительно заполнено как
<literal>no</literal>, его изменение не имеет значения, так как нет
такого понятия, как конфиденциальное сообщение о
проблеме&mdash;база данных PR распространяется по всему миру
посредством <application>CVSup</application>.</para>
</listitem>
<listitem>
<para><emphasis>Confidential:</emphasis> Предварительно заполнено как
<literal>no</literal>, его изменение не имеет значения, так как нет
такого понятия, как конфиденциальное сообщение о
проблеме&mdash;база данных PR распространяется по всему миру
посредством <application>CVSup</application>.</para>
</listitem>
</itemizedlist>
<para>Далее описаны общие поля для почтового и <ulink
url="&url.base;/send-pr.html">веб интерфейса</ulink>:</para>
<itemizedlist>
<listitem>
<para><emphasis>Originator:</emphasis> Пожалуйста,
укажите ваше реальное имя, за которым опционально следует
@ -724,9 +724,9 @@
<listitem>
<para><emphasis>Severity:</emphasis> Одно из
<literal>non-critical</literal>,
<literal>serious</literal> или <literal>critical</literal>. Не
<literal>serious</literal> или <literal>critical</literal>. Не
переусердствуйте; избегайте пометки вашей проблемы как
<literal>critical</literal>, если только это не действительно
<literal>critical</literal>, если только это не действительно
критичная проблема (повреждение данных, существенная потеря
функциональности в -CURRENT),
или <literal>serious</literal>, если только это не касается многих
@ -749,8 +749,8 @@
<listitem>
<para><emphasis>Priority:</emphasis> Одно из
<literal>low</literal>, <literal>medium</literal> или
<literal>high</literal>. <literal>high</literal> должен
<literal>low</literal>, <literal>medium</literal> или
<literal>high</literal>. <literal>high</literal> должен
использоваться для проблем, которые затронут конкретно
каждого пользователя &os;, а <literal>medium</literal> для чего-то,
что затронет многих пользователей.</para>
@ -922,6 +922,7 @@
<para>Вот текущий перечень категорий (взят из
<ulink url="http://www.FreeBSD.org/cgi/cvsweb.cgi/src/gnu/usr.bin/send-pr/categories"></ulink>):</para>
<itemizedlist>
<listitem>
<para><literal>advocacy:</literal> проблемы, связанные с
@ -1016,15 +1017,15 @@
соответствием стандартам.</para>
</listitem>
<listitem>
<para><literal>threads:</literal> проблемы, касающиеся
<listitem>
<para><literal>threads:</literal> проблемы, касающиеся
реализации тредов во &os; (особенно во &os.current;).</para>
</listitem>
</listitem>
<listitem>
<para><literal>usb:</literal> проблемы, относящиеся к реализации
USB во &os;.</para>
</listitem>
<listitem>
<para><literal>usb:</literal> проблемы, относящиеся к реализации
USB во &os;.</para>
</listitem>
<listitem>
<para><literal>www:</literal> изменения или улучшения сайта
@ -1165,9 +1166,9 @@
который вы можете использовать для проверки его состояния. В случае
удачи кто-нибудь проявит интерес к вашей проблеме и попытается ее
решить, или, как это бывает, описать, почему это не является проблемой.
Вы будете автоматически оповещаться о любом изменении состояния и получать
копии всех комментариев или патчей, которые будут присоединяться в
процессе отработки вашего сообщения о проблеме.</para>
Вы будете автоматически оповещаться о любом изменении состояния
и получать копии всех комментариев или патчей, которые будут
присоединяться в процессе отработки вашего сообщения о проблеме.</para>
<para>Если кто-то запросит дополнительную информацию от вас, или вы
вспомните или обнаружите нечто, что не указали в начальном сообщении,
@ -1176,28 +1177,28 @@
<itemizedlist>
<listitem>
<para>Самый простой путь это использовать соответствующую ссылку
(followup) на индивидуальной веб страничке сообщения об ошибки, к
которой можно перейти, используя <ulink url
="http://www.FreeBSD.org/cgi/query-pr-summary.cgi?query">страничку
поиска PR</ulink>. Кликнув на этой ссылке откроется окно для отправки
email с уже корректно заполненными полями To: и Subject: (если ваш
браузер сконфигурирован для этого).</para>
<para>Самый простой путь это использовать соответствующую ссылку
(followup) на индивидуальной веб страничке сообщения об ошибки, к
которой можно перейти, используя <ulink url
="http://www.FreeBSD.org/cgi/query-pr-summary.cgi?query">страничку
поиска PR</ulink>. Кликнув на этой ссылке откроется окно для
отправки email с уже корректно заполненными полями To: и Subject:
(если ваш браузер сконфигурирован для этого).</para>
</listitem>
<listitem>
<para>Или просто пошлите письмо на адрес
&a.bugfollowup;, включив отслеживаемый номер
в теме письма, чтобы система отслеживания сообщений могла знать, к
какому сообщению о проблеме его присоединить.</para>
<para>Или просто пошлите письмо на адрес &a.bugfollowup;, включив
отслеживаемый номер в теме письма, чтобы система отслеживания
сообщений могла знать, к какому сообщению о проблеме его
присоединить.</para>
<note>
<para>Если вы <emphasis>не</emphasis> включите отслеживаемый номер,
GNATS растеряется и создаст совершенно новое PR, которое будет
закреплено за администратором GNATS. В результате ваш отклик
затеряется до тех пор пока кто-нибудь не начнёт разгребать
скопившийся мусор, что может произойти спустя дни или даже
недели.</para>
<note>
<para>Если вы <emphasis>не</emphasis> включите отслеживаемый номер,
GNATS растеряется и создаст совершенно новое PR, которое будет
закреплено за администратором GNATS. В результате ваш отклик
затеряется до тех пор пока кто-нибудь не начнёт разгребать
скопившийся мусор, что может произойти спустя дни или даже
недели.</para>
<para>Неправильно:</para>
@ -1206,14 +1207,15 @@
<para>Правильно:</para>
<programlisting>Subject: Re: ports/12345: compilation problem with foo/bar</programlisting>
</note>
</note>
</listitem>
</itemizedlist>
<para>Если сообщение о проблеме остается открытым после того, как проблема
была решена, просто отправьте сообщение (так, как это описано
выше), с указанием, что сообщение о проблеме может быть закрыто, и
если это возможно, объясните, как и когда проблема была устранена.</para>
<para>Если сообщение о проблеме остается открытым после того, как
проблема была решена, просто отправьте сообщение (так, как это
описано выше), с указанием, что сообщение о проблеме может быть
закрыто, и если это возможно, объясните, как и когда проблема была
устранена.</para>
</section>
<section id="pr-problems">
@ -1268,11 +1270,12 @@
написал Simon G. Tatham о составлении полезных (не специфичных для
&os;) сообщений о проблемах.</para>
</listitem>
<listitem>
<para><ulink url="&url.articles.pr-guidelines;/article.html">Problem
Report Handling Guidelines</ulink>&mdash;интересный взгляд на
обработку сообщений о проблемах самими разработчиками &os;.</para>
</listitem>
</listitem>
</itemizedlist>
</section>
</article>