From d4455f574f87ef7c51607f16c2c3466b8fd4216d Mon Sep 17 00:00:00 2001 From: Taras Korenko Date: Fri, 9 Jul 2010 20:24:59 +0000 Subject: [PATCH] - nothing but formatting was changed Approved by: maxim (mentor), marck (mentor) --- .../articles/problem-reports/article.sgml | 269 +++++++++--------- 1 file changed, 136 insertions(+), 133 deletions(-) diff --git a/ru_RU.KOI8-R/articles/problem-reports/article.sgml b/ru_RU.KOI8-R/articles/problem-reports/article.sgml index 552526ecef..d69c13bf3c 100644 --- a/ru_RU.KOI8-R/articles/problem-reports/article.sgml +++ b/ru_RU.KOI8-R/articles/problem-reports/article.sgml @@ -88,28 +88,29 @@ деле вы неправильно поняли синтаксис команды или сделали опечатку в конфигурационном файле (хотя само по себе это иногда говорит о плохой документации или неправильной обработке ошибок в прикладной программе). - Есть еще много случаев, когда посылка сообщения о проблеме явно не - является правильным действием, а только приводит к разочарованию вас и - разработчиков. И наоборот, есть случаи, когда может быть нужно послать - сообщение о чем-то, не являющемся ошибкой—к примеру, запрос на - доработку или расширение функциональности. + Есть еще много случаев, когда посылка сообщения о проблеме явно + не является правильным действием, а только + приводит к разочарованию вас и разработчиков. И наоборот, есть случаи, + когда может быть нужно послать сообщение о чем-то, не являющемся + ошибкой—к примеру, запрос на доработку или расширение + функциональности. Но как же определить, что является ошибкой, а что нет? Простым - правилом, которому нужно следовать, является следующее – ваша проблема - не является ошибкой, если она формулируется как - вопрос (обычно в форме Как сделать X? или Где можно - найти Y?). Не всегда это так однозначно, но правило вопроса - покрывает большинство случаев. Если Вам нужен ответ, лучше всего задать - свой вопрос в &a.questions;. + правилом, которому нужно следовать, является следующее – ваша + проблема не является ошибкой, если она формулируется + как вопрос (обычно в форме Как сделать X? или Где + можно найти Y?). Не всегда это так однозначно, но правило + вопроса покрывает большинство случаев. Если Вам нужен ответ, лучше всего + задать свой вопрос в &a.questions;. Вот некоторые случаи, в которых может оказаться полезным отправить сообщение о чем-то, что не является ошибкой: - Запросы на расширение функциональности. Обычно хорошей идеей является - озвучивание этого в списках рассылки до того, как посылать сообщение - о проблеме. + Запросы на расширение функциональности. Обычно хорошей идеей + является озвучивание этого в списках рассылки до того, как посылать + сообщение о проблеме. @@ -118,27 +119,27 @@ и компоненты базовой системы, разрабатываемые сторонними организациями, такие, как BIND или различные утилиты GNU). - Для не поддерживаемых никем портов (переменная MAINTAINER + Для не поддерживаемых никем портов (переменная + MAINTAINER содержит ports@FreeBSD.org), такие уведомления о - обновлении будут замечены заинтересовавшимся коммиттером и вас - могут попросить предоставить патч для обновления порта; предоставление патча - до того, как вас попросят об этом сильно увеличит шансы того, + обновлении будут замечены заинтересовавшимся коммиттером и вас могут + попросить предоставить патч для обновления порта; предоставление + патча до того, как вас попросят об этом сильно увеличит шансы того, что порт будет обновлён вовремя. - + Если порт поддерживается, PR-ы, указывающие о появлении новых улучшенных (upstream) релизов обычно не очень полезны, так как они прибавляют много вспомогательной работы для коммиттеров, а мэйнтейнер наверняка уже знает о новой версии. Они уже наверняка работали с разработчиками над ней или они возможно тестируют её, чтобы убедиться в отсутствии регрессии и т.п. - + В любом случае, следование процессу, описанному в Руководстве по созданию портов даст наилучшие результаты. (Также можно ознакомиться с статьей Контрибуция в коллекцию портов FreeBSD.) - @@ -178,10 +179,10 @@ разработчикам, если проблемы не являются специфичными для &os;. Обычно ошибки такого рода попадают под категории bin или gnu. - + - - Отдельные приложения, не входящие в базовую систему, + + Отдельные приложения, не входящие в базовую систему, но являющиеся частью Коллекции Портов &os; (категория ports). Большинство этих приложений не пишется разработчиками &os;; что предоставляет &os;, @@ -199,9 +200,9 @@ Если проблема в базовой системе, то вам нужно сначала прочесть раздел версии &os; - из FAQ, если вы ещё не знакомы с данной темой. Для &os; возможно - исправлять проблемы только для некоторых недавних веток базовой + url="&url.books.faq;/introduction.html#LATEST-VERSION">версии + &os; из FAQ, если вы ещё не знакомы с данной темой. Для &os; + возможно исправлять проблемы только для некоторых недавних веток базовой системы, поэтому отправка сообщения об ошибке для более старой версии приведёт к тому, что разработчик посоветует вам обновиться до поддерживаемой версии, чтобы посмотреть присутствует ли в ней @@ -216,7 +217,6 @@ является поддержка чего-либо, кроме самых последних версий, и проблемы со устаревшими версиями приложений просто не могут быть исправлены. -
@@ -269,20 +269,20 @@ база данных PR &os; (GNATS). Если только ваша проблема не нова или редка, есть некоторый шанс, что о ней уже сообщено. - + И самое важное, вы должны посмотреть не затрагивает ли документация в базовой системе вашу проблему. - + Для основного кода &os; вы должны тщательно изучить содержимое файла /usr/src/UPDATING или его текущую версию - по адресу - . + по адресу . (Если вы переходите с одной версии на другую, особенно если вы обновляетесь до &os.current;, то в этом файле вы можете найти много важной информации). - + Если же ваша проблема связана с коллекцией портов &os;, вы должны обратиться к файлу /usr/ports/UPDATING (изменения, касающиеся индивидуальных портов) или к @@ -290,8 +290,6 @@ коллекции портов). Они также доступны через интерфейс CVSweb: и . - -
@@ -303,11 +301,12 @@ категорию сообщения о проблеме, и это проблема &os;, самое время написать собственно сообщение о проблеме (PR). Прежде чем мы углубимся в частности использования программы для создания и отправки PR, вот - несколько советов, которые помогут вам сделать PR более эффективным. - + несколько советов, которые помогут вам сделать PR более + эффективным.
Как писать хорошие сообщения о проблемах + @@ -348,9 +347,9 @@ Если у вас есть готовый патч, скажите об этом. PR, содержащий патч, имеет куда больше шансов быть рассмотренным. В этом случае добавьте строку - [patch] (включая квадратные скобки) в начало поля Synopsis - (хотя использование именно этой формы необязательно, она является - стандартом де-факто). + [patch] (включая квадратные скобки) в начало + поля Synopsis (хотя использование именно этой формы + необязательно, она является стандартом де-факто). @@ -358,16 +357,16 @@ этом. Если вы отвечаете за часть исходных текстов (например, порт), вы можете добавить в начало поля Synopsis строку - [maintainer update] (включая квадратные скобки), а также установить класс - вашего PR (поле Class) в + [maintainer update] (включая квадратные скобки), + а также установить класс вашего PR (поле Class) в maintainer-update. В этом случае коммиттеру, обрабатывающему ваш PR, не придётся лишний раз проверять. - Будьте точны в формулировках. - Чем больше информации вы можете предоставить о проблеме, тем больше - у вас шансов получить ответ. + Будьте точны в формулировках. Чем больше + информации вы можете предоставить о проблеме, тем больше у вас + шансов получить ответ. @@ -376,10 +375,10 @@ и на какой архитектуре. Сообщите, используете ли вы release версию (установили с компакт-диска либо загрузили) или скачали её с помощью &man.cvsup.1; (если так, то как давно вы - обновлялись). Если вы используйте &os.current;, то первый вопрос, - который вам могут задать, будет про дату последнего обновления, - так как исправления для этой ветки имеют - тенденцию (особенно для серьёзных проблем) появляться слишком + обновлялись). Если вы используйте &os.current;, то первый + вопрос, который вам могут задать, будет про дату последнего + обновления, так как исправления для этой ветки имеют тенденцию + (особенно для серьёзных проблем) появляться слишком быстро. @@ -390,7 +389,7 @@ &man.gcc.1; во многих случаях может быть причиной ошибок. Хотя и разработчики &os; будут принимать патчи, у них не будет желания исследовать такие случаи из-за отсутствия времени и - добровольцев, и вместо этого они могут ответить, что это не + добровольцев, и вместо этого они могут ответить, что это не поддерживается. @@ -406,21 +405,23 @@ - Если ваша проблема связана с ядром, будьте готовы предоставить - следующую информацию (вам не обязательно включать её всю, она пойдёт лишь - на заполнение базы данных, но вы должны включить информацию, - которая по вашему мнению актуальна): + Если ваша проблема связана с ядром, будьте готовы + предоставить следующую информацию (вам не обязательно включать + её всю, она пойдёт лишь на заполнение базы данных, но вы должны + включить информацию, которая по вашему мнению актуальна): - Вашу конфигурацию ядра, включая то, какие устройства у вас - установлены + Вашу конфигурацию ядра, включая то, какие устройства + у вас установлены + Включены ли у вас опции отладки (например, WITNESS), и если так, то существует ли проблема после изменения значения этой опции + Полный вывод обратной трассировки (backtrace), паники или иного консольного вывода, или же записи из @@ -434,11 +435,13 @@ в случае, если проблема связана с конкретным оборудованием + - Прочли ли вы src/UPDATING, описана ли - там ваша проблема (кто-нибудь спросит обязательно) - + Прочли ли вы src/UPDATING, + описана ли там ваша проблема (кто-нибудь спросит + обязательно) + Запускается ли другое ядро (это для тех случаев, когда причиной сбоя стало оборудование, например @@ -453,17 +456,19 @@ следующую информацию (вам не обязательно включать её всю, она пойдет лишь на заполнение базы данных, но вы должны включить информацию, которая по вашему мнению актуальна): - + Какие порты вы устанавливали + Имеются ли какие-либо переменные окружения, которые переписывают первоначально-установленные в bsd.port.mk, такие как, PORTSDIR) + Прочли ли вы ports/UPDATING, и описана ли там ваша проблема (кто-нибудь спросит @@ -471,10 +476,8 @@ - - - + Избегайте нечетких запросов о новых @@ -535,17 +538,18 @@
Прежде всего - Если вы используйте утилиту &man.send-pr.1; проверьте, что переменная - вашего окружения VISUAL (или EDITOR, если - VISUAL не задана) задана подходящим образом. + Если вы используйте утилиту &man.send-pr.1; проверьте, что + переменная вашего окружения VISUAL (или + EDITOR, если VISUAL не задана) задана + подходящим образом. Следует также проверить работоспособность системы электронной почты. Утилита &man.send-pr.1; использует почтовую систему для отправки и отслеживания сообщения о проблеме. Если с машины, на которой вы запускаете &man.send-pr.1;, нельзя отправить почту, - сообщение не попадёт в базу данных GNATS. О настройке электронной - почты во &os; можно прочитать в главе Электронная - почта Руководства по &os; по адресу Электронная + почта Руководства по &os; по адресу . Убедитесь, что ваш почтовый клиент не исказит сообщение по @@ -557,11 +561,10 @@ для читабельности PR на веб странице. Примерные соображения должны учитываться при отправке - сообщения об ошибке через - веб-форму - вместо &man.send-pr.1;. - Помните, что операции копирования-вставки могут иметь - сторонние эффекты в форматировании текста. В определённых + сообщения об ошибке через веб-форму вместо + &man.send-pr.1;. Помните, что операции копирования-вставки могут + иметь сторонние эффекты в форматировании текста. В определённых случаях может быть необходимо использовать &man.uuencode.1; для гарантии того, что патчи придут не изменёнными. @@ -569,7 +572,6 @@ приготовить его в offline, чтобы ничего не потерялось в случае, если будет проблема при его отправке. Это особенно касается веб-формы. -
@@ -611,16 +613,16 @@ Это выполнит экранирование (escaping) символов и весь патч будет бесполезным. - Следует также заметить, что включение небольших патчей в сообщение о - проблеме является приемлемой практикой, в особенности если они решают + Следует также заметить, что включение небольших патчей в сообщение + о проблеме является приемлемой практикой, в особенности если они решают проблему, описанную в сообщении, большие же патчи, а в особенности новый код, который может требовать значительного просмотра перед тем, как он будет внесен в дерево исходных текстов, должны быть размещены на web- или ftp-сервере, а в сообщение о проблеме должен быть включён - только URL указывающий на этот патч. Очень часто патчи, пересылаемые по - электронной почте, а в особенности если задействована GNATS, бывают + только URL указывающий на этот патч. Очень часто патчи, пересылаемые + по электронной почте, а в особенности если задействована GNATS, бывают искажены, и, как следствие, чем больше патч, тем труднее будет для - заинтересованных людей привести его к нормальному виду. Также то, что + заинтересованных людей привести его к нормальному виду. Также то, что патч будет размещён отдельно от сообщения о проблеме, даёт возможность изменять его не отсылая полный патч в дополнение к изначальному сообщению о проблеме. И наконец, большие патчи просто увеличивают @@ -641,12 +643,11 @@ PR через электронную почту: После запуска утилиты &man.send-pr.1; вам будет представлен шаблон - сообщения о проблеме. - Шаблон состоит из списка полей, некоторые из которых уже заполнены, - а некоторые содержат комментарии, объясняющие назначение поля или - перечисляющие подходящие значения. Не беспокойтесь о комментариях; они - будут автоматически удалены, если вы их не изменяли (или удалите их - сами). + сообщения о проблеме. Шаблон состоит из списка полей, некоторые из + которых уже заполнены, а некоторые содержат комментарии, объясняющие + назначение поля или перечисляющие подходящие значения. Не беспокойтесь + о комментариях; они будут автоматически удалены, если вы их не изменяли + (или удалите их сами). Вверху шаблона, ниже строк SEND-PR: находятся заголовки почтового сообщения. Вам обычно не нужно их изменять, если @@ -667,20 +668,19 @@ вы используете &os.stable;. - - Confidential: Предварительно заполнено как - no, его изменение не имеет значения, так как нет - такого понятия, как конфиденциальное сообщение о - проблеме—база данных PR распространяется по всему миру - посредством CVSup. - + + Confidential: Предварительно заполнено как + no, его изменение не имеет значения, так как нет + такого понятия, как конфиденциальное сообщение о + проблеме—база данных PR распространяется по всему миру + посредством CVSup. + Далее описаны общие поля для почтового и веб интерфейса: - Originator: Пожалуйста, укажите ваше реальное имя, за которым опционально следует @@ -724,9 +724,9 @@ Severity: Одно из non-critical, - serious или critical. Не + serious или critical. Не переусердствуйте; избегайте пометки вашей проблемы как - critical, если только это не действительно + critical, если только это не действительно критичная проблема (повреждение данных, существенная потеря функциональности в -CURRENT), или serious, если только это не касается многих @@ -749,8 +749,8 @@ Priority: Одно из - low, medium или - high. high должен + low, medium или + high. high должен использоваться для проблем, которые затронут конкретно каждого пользователя &os;, а medium для чего-то, что затронет многих пользователей. @@ -922,6 +922,7 @@ Вот текущий перечень категорий (взят из ): + advocacy: проблемы, связанные с @@ -1016,15 +1017,15 @@ соответствием стандартам. - - threads: проблемы, касающиеся + + threads: проблемы, касающиеся реализации тредов во &os; (особенно во &os.current;). - + - - usb: проблемы, относящиеся к реализации - USB во &os;. - + + usb: проблемы, относящиеся к реализации + USB во &os;. + www: изменения или улучшения сайта @@ -1165,9 +1166,9 @@ который вы можете использовать для проверки его состояния. В случае удачи кто-нибудь проявит интерес к вашей проблеме и попытается ее решить, или, как это бывает, описать, почему это не является проблемой. - Вы будете автоматически оповещаться о любом изменении состояния и получать - копии всех комментариев или патчей, которые будут присоединяться в - процессе отработки вашего сообщения о проблеме. + Вы будете автоматически оповещаться о любом изменении состояния + и получать копии всех комментариев или патчей, которые будут + присоединяться в процессе отработки вашего сообщения о проблеме. Если кто-то запросит дополнительную информацию от вас, или вы вспомните или обнаружите нечто, что не указали в начальном сообщении, @@ -1176,28 +1177,28 @@ - Самый простой путь это использовать соответствующую ссылку - (followup) на индивидуальной веб страничке сообщения об ошибки, к - которой можно перейти, используя страничку - поиска PR. Кликнув на этой ссылке откроется окно для отправки - email с уже корректно заполненными полями To: и Subject: (если ваш - браузер сконфигурирован для этого). + Самый простой путь это использовать соответствующую ссылку + (followup) на индивидуальной веб страничке сообщения об ошибки, к + которой можно перейти, используя страничку + поиска PR. Кликнув на этой ссылке откроется окно для + отправки email с уже корректно заполненными полями To: и Subject: + (если ваш браузер сконфигурирован для этого). - Или просто пошлите письмо на адрес - &a.bugfollowup;, включив отслеживаемый номер - в теме письма, чтобы система отслеживания сообщений могла знать, к - какому сообщению о проблеме его присоединить. + Или просто пошлите письмо на адрес &a.bugfollowup;, включив + отслеживаемый номер в теме письма, чтобы система отслеживания + сообщений могла знать, к какому сообщению о проблеме его + присоединить. - - Если вы не включите отслеживаемый номер, - GNATS растеряется и создаст совершенно новое PR, которое будет - закреплено за администратором GNATS. В результате ваш отклик - затеряется до тех пор пока кто-нибудь не начнёт разгребать - скопившийся мусор, что может произойти спустя дни или даже - недели. + + Если вы не включите отслеживаемый номер, + GNATS растеряется и создаст совершенно новое PR, которое будет + закреплено за администратором GNATS. В результате ваш отклик + затеряется до тех пор пока кто-нибудь не начнёт разгребать + скопившийся мусор, что может произойти спустя дни или даже + недели. Неправильно: @@ -1206,14 +1207,15 @@ Правильно: Subject: Re: ports/12345: compilation problem with foo/bar - + - - Если сообщение о проблеме остается открытым после того, как проблема - была решена, просто отправьте сообщение (так, как это описано - выше), с указанием, что сообщение о проблеме может быть закрыто, и - если это возможно, объясните, как и когда проблема была устранена. + + Если сообщение о проблеме остается открытым после того, как + проблема была решена, просто отправьте сообщение (так, как это + описано выше), с указанием, что сообщение о проблеме может быть + закрыто, и если это возможно, объясните, как и когда проблема была + устранена.
@@ -1268,11 +1270,12 @@ написал Simon G. Tatham о составлении полезных (не специфичных для &os;) сообщений о проблемах. + Problem Report Handling Guidelines—интересный взгляд на обработку сообщений о проблемах самими разработчиками &os;. - +