35babe0ae5
set on some files as a workaround for binary check. - Fix pathname for svn co in the webupdate script. Approved by: doceng (implicit)
148 lines
5.2 KiB
Text
148 lines
5.2 KiB
Text
<!--
|
||
The FreeBSD Russian Documentation Project
|
||
|
||
$FreeBSDru: frdp/www/ru/docproj/submitting.sgml,v 1.9 2004/09/21 07:31:05 den Exp $
|
||
|
||
Original revision: 1.14
|
||
-->
|
||
|
||
<!DOCTYPE HTML PUBLIC "-//FreeBSD//DTD HTML 4.01 Transitional-Based Extension//EN" [
|
||
<!ENTITY base CDATA "..">
|
||
<!ENTITY date "$FreeBSD$">
|
||
<!ENTITY title "Проект Документирования FreeBSD: Посылка документации">
|
||
<!ENTITY % navinclude.docs "INCLUDE">
|
||
]>
|
||
|
||
<html>
|
||
&header;
|
||
|
||
<h2>Я написал некоторое количество документации. Как вам её послать?</h2>
|
||
|
||
<p>Во-первых, спасибо, что вы нашли время и сделали это.</p>
|
||
|
||
<p>Вы должны сделать вашу документацию доступной для предварительного
|
||
просмотра. Если это возможно, поместите её на FTP или веб-сервер.</p>
|
||
|
||
<p>После этого пошлите сообщение в список рассылки -doc с кратким
|
||
описанием документации и ссылкой на её местоположение, а также
|
||
просьбой поделиться отзывами.</p>
|
||
|
||
<p>Если по каким-то причинам вы не можете поместить документацию на
|
||
какой-либо FTP или веб-сервер, то пошлите её непосредственно в список
|
||
рассылки -doc. Если вы собираетесь поступить именно так, то присылайте
|
||
документы в формате обычного текста.</p>
|
||
|
||
<p>Скорее всего, вы ещё понадобится сделать cc: этого запроса на
|
||
комментарии в другие подходящие списки рассылки. Например, что-либо,
|
||
относящееся к использованию CVSup для синхронизации дерева исходных
|
||
текстов, будет интересно подписчикам списков рассылки
|
||
<tt>FreeBSD-current</tt> и <tt>FreeBSD-stable</tt>.</p>
|
||
|
||
<p>После того, как люди посмотрели на вашу документацию, и вы получили
|
||
шанс включить в документ любые из их пожеланий, вы уже можете посылать
|
||
эту документацию.</p>
|
||
|
||
<p>Чтобы сделать это, заархивируйте её в один tar-файл. Если ваша
|
||
документация состоит из трех файлов, <tt>one</tt>, <tt>two</tt>
|
||
и <tt>three</tt>, а вы хотите получить их в виде <tt>doc.tar</tt>,
|
||
сделайте следующее:</p>
|
||
|
||
<pre>
|
||
% <b>tar cf doc.tar one two three</b>
|
||
</pre>
|
||
|
||
<p>Затем выполните сжатие tar-файла:</p>
|
||
|
||
<pre>
|
||
% <b>gzip -9 doc.tar</b>
|
||
</pre>
|
||
|
||
<p>в результате чего появится <tt>doc.tar.gz</tt>.</p>
|
||
|
||
<p>И, наконец, перекодируйте файл в вид, который подходит для передачи
|
||
через любую программу электронной почты.</p>
|
||
|
||
<pre>
|
||
% <b>uuencode doc.tar.gz doc.tar.gz > doc.uue</b>
|
||
</pre>
|
||
|
||
<p>Теперь дайте знать о нём группе Проекта Документирования. Правильным
|
||
способом сделать это является использование программы <b>send-pr</b>,
|
||
которая должна иметься на вашей машине.</p>
|
||
|
||
<p>Вы делаете это для того, чтобы ваше послание могло быть отслежено.
|
||
Когда вы оформляете PR (Problem Report - сообщение о проблеме), ему
|
||
назначается уникальный номер. Один из коммиттеров может затем
|
||
направить PR себе, и установить с вами связь по поводу включения
|
||
новой документации в систему.</p>
|
||
|
||
<p><b>send-pr</b> сама по себе очень проста. Все, что она делает - это
|
||
посылка электронной почты, оформленной особым образом, на определенный
|
||
адрес. Когда вы запускаете <b>send-pr</b>, вы оказываетесь в
|
||
текстовом редакторе (вероятнее всего, <b>vi</b> или <b>emacs</b>) с
|
||
бланком для заполнения и некоторыми инструкциями по заполнению.</p>
|
||
|
||
<p>Удостоверьтесь, что пункт "Category" установлен в "docs", а в строчке
|
||
"Class" фигурирует только лишь "change-request". Вы должны включить
|
||
в это PR ранее созданный файл <tt>.uue</tt>.
|
||
|
||
<p>Когда вы завершите работу с редактором, PR будет послано по
|
||
электронной почте туда, куда нужно. Вскоре вы получите подтверждающее
|
||
сообщение, вкратце говорящее, какой номер был назначен PR, и этот
|
||
номер может быть использован для отслеживания его судьбы.</p>
|
||
|
||
<h2>Я сделал некоторые изменения и исправления в существующей документации,
|
||
как вам их послать?</h2>
|
||
|
||
<p>Мы снова благодарим вас за то, что вы потратили на это время.</p>
|
||
|
||
<p>Прежде всего вам нужно сгенерировать особый файл, называемый
|
||
<i>diff</i>. В этом diff-файле содержатся только изменения, которые
|
||
вы внесли. Это облегчает персоне, выполняющей внесение изменений в
|
||
систему, просмотр ваших изменений, что означает ненужность траты
|
||
массы времени на объяснения, что конкретно было изменено (хотя вы
|
||
должны будете объяснить, почему эти изменения так необходимы).</p>
|
||
|
||
<p>Чтобы сделать 'diff', вы должны:</p>
|
||
|
||
<ol>
|
||
<li>
|
||
<p>Сделать копию файла, который собираетесь менять. Если вы
|
||
изменяете <tt>foo.sgml</tt>, выполните</p>
|
||
|
||
<pre>
|
||
% <b>cp foo.sgml foo.sgml.old</b>
|
||
</pre>
|
||
</li>
|
||
|
||
<li><p>Затем внесите ваши изменения в foo.sgml</p>
|
||
|
||
<pre>
|
||
% <b>vi foo.sgml</b>
|
||
... клац клац клац ...
|
||
|
||
... тестируем изменения, ищем опечатки, и тому подобное ...
|
||
</pre>
|
||
</li>
|
||
|
||
<li><p>Делаем diff. Команда, это делающая:</p>
|
||
|
||
<pre>
|
||
% <b>diff -ru foo.sgml.old foo.sgml > foo.diff</b>
|
||
</pre>
|
||
|
||
<p>Здесь выполняется просмотр отличий между двумя файлами и запись
|
||
этих отличий в файл <tt>foo.diff</tt>.</p>
|
||
</li>
|
||
</ol>
|
||
|
||
<p>После этого вы можете послать <tt>foo.diff</tt> обратно в адрес проекта.
|
||
Пошлите PR так, как это было описано выше, включив в тело письма
|
||
файл <tt>foo.diff</tt>.</p>
|
||
|
||
<p></p><a href="docproj.html">Проект Документирования FreeBSD</a>
|
||
|
||
&footer;
|
||
|
||
</body>
|
||
</html>
|