Initial import, synchronized with English 1.5
This commit is contained in:
Andrey Zakhvatov
parent
53543f6296
commit
e58137e49c
Notes:
svn2git
2020-12-08 03:00:23 +00:00
svn path=/www/; revision=6180
1 changed files with 146 additions and 0 deletions
146
ru/docproj/submitting.sgml
Normal file
146
ru/docproj/submitting.sgml
Normal file
|
|
@ -0,0 +1,146 @@
|
||||||
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN" [
|
||||||
|
<!ENTITY base CDATA "..">
|
||||||
|
<!ENTITY date "$FreeBSD: www/en/docproj/submitting.sgml,v 1.4 1999/09/06 07:02:43 peter Exp $">
|
||||||
|
<!ENTITY title "FreeBSD Documentation Project: Посылка документации">
|
||||||
|
<!ENTITY % includes SYSTEM "../includes.sgml"> %includes;
|
||||||
|
]>
|
||||||
|
<!-- $FreeBSD: www/en/docproj/submitting.sgml,v 1.4 1999/09/06 07:02:43 peter Exp $ -->
|
||||||
|
|
||||||
|
<html>
|
||||||
|
&header;
|
||||||
|
|
||||||
|
<h2>Я написал некоторое количество документации. Как вам ее послать?</h2>
|
||||||
|
|
||||||
|
<p>Во-первых, спасибо, что вы нашли время и сделали это.</p>
|
||||||
|
|
||||||
|
<p>Вы должны сделать вашу документацию доступной для предварительного
|
||||||
|
просмотра. Если это возможно, поместите ее на FTP или веб. Если у
|
||||||
|
вас нет собственного FTP или веб-пространства, закачайте вашу
|
||||||
|
документацию в каталог <a
|
||||||
|
href="ftp://ftp.FreeBSD.ORG/pub/FreeBSD/incoming/">ftp://ftp.FreeBSD.ORG/pub/FreeBSD/incoming/</a>
|
||||||
|
и воспользуйтесь командой <b>send-pr</b> (как это описано ниже), чтобы
|
||||||
|
кто-нибудь из коммиттеров сделал ее общедоступной.</p>
|
||||||
|
|
||||||
|
<p>После этого пошлите сообщение в список рассылки -doc с кратким
|
||||||
|
описанием документации и ссылкой на ее местоположение а также
|
||||||
|
требованием поделиться комментариями.</p>
|
||||||
|
|
||||||
|
<p>Скорее всего, вы еще должны будете сделать cc: этого запроса на
|
||||||
|
комментарии в другие подходящие списки рассылки. Например, что-либо,
|
||||||
|
относящееся к использованию CVSup для синхронизации дерева исходных
|
||||||
|
текстов, будет интересно подписчикам списков рассылки
|
||||||
|
<tt>FreeBSD-current</tt> и <tt>FreeBSD-stable</tt>.</p>
|
||||||
|
|
||||||
|
<p>После того, как люди посмотрели на вашу документацию, и вы получили
|
||||||
|
шанс включить в документ любые из их пожеланий, вы готовы послать
|
||||||
|
эту документацию.</p>
|
||||||
|
|
||||||
|
<p>Чтобы сделать это, заархивируйте ее в один tar-файл. Если ваша
|
||||||
|
документация состоит из трех файлов, <tt/one/, <tt/two/, и <tt/three/,
|
||||||
|
и вы хотите получить их в виде <tt/doc.tar/, сделайте следующее:</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>После этого вы должны закачать файл <tt/doc.tar.gz/ (лучше дать ему
|
||||||
|
более подходящее имя, но оставить постфикс <tt/.tar.gz/) на сервер
|
||||||
|
<tt/ftp.FreeBSD.org/, поместив его в каталог
|
||||||
|
<tt>/pub/FreeBSD/incoming/</tt>.</p>
|
||||||
|
|
||||||
|
<p>Теперь дайте знать о нем группе Documentation Project. Правильным
|
||||||
|
способом сделать это является использование команды <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". И не забудьте указать имя файла, которое
|
||||||
|
вы закачали, чтобы коммиттеры могли его найти!</p>
|
||||||
|
|
||||||
|
<p>Когда вы завершите работу с редактором, PR будет послано по
|
||||||
|
электронной почте туда, куда нужно. Вскоре вы получите подтверждающее
|
||||||
|
сообщение, вкратце говорящее, какой номер был назначен PR, и этот
|
||||||
|
номер может быть использован для отслеживания его судьбы.</p>
|
||||||
|
|
||||||
|
<p>Как альтернативу вы можете использовать веб-интерфейс по адресу <a
|
||||||
|
href="http://www.FreeBSD.org/send-pr.html">http://www.freebsd.org/send-pr.html</a>.</p>
|
||||||
|
|
||||||
|
<h2>Я сделал некоторые изменения в существующей докуентации, как вам их
|
||||||
|
послать?</h2>
|
||||||
|
|
||||||
|
<p>И снова благодарим вас за то, что вы потратили на это время.</p>
|
||||||
|
|
||||||
|
<p>Прежде всего вам нужно сгенерировать особый файл, называемый
|
||||||
|
<i>diff</i>. В этом diff-файле содержатся только изменения, которые
|
||||||
|
вы внесли. Это облегчает персоне, выполняюшей внесение изменений в
|
||||||
|
систему, просмотр ваших изменений, что означает ненужность траты
|
||||||
|
массы времени на объяснения, что конкретно было изменено (хотя вы
|
||||||
|
должны будете объяснить, почему эти изменения так необходимы).</p>
|
||||||
|
|
||||||
|
<p>Чтобы сделать 'diff', вы должны;</p>
|
||||||
|
|
||||||
|
<ol>
|
||||||
|
<li><p>Сделать копию файла, который собираетесь менять. Если вы
|
||||||
|
изменяете <tt/foo.sgml/, выполните</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 -c foo.sgml.old foo.sgml > foo.diff</b>
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
<p>Здесь выполняется просмотр отличий между двумя файлами и запись
|
||||||
|
этих отличий в файл <tt/foo.diff/.</p></li>
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
<p>После этого вы можете послать <tt/foo.diff/ обратно в адрес проекта.</p>
|
||||||
|
|
||||||
|
<p>Вы можете поместить файл <tt/foo.diff/ по FTP в <a
|
||||||
|
href="ftp://ftp.FreeBSD.ORG/pub/FreeBSD/incoming/">ftp://ftp.FreeBSD.ORG/pub/FreeBSD/incoming/</a>
|
||||||
|
или, если он достаточно маленький (скажем, вы просто исправляете
|
||||||
|
опечатку), вы можете включить diff непосредственно в PR, в раздел
|
||||||
|
"Fix:".</p>
|
||||||
|
|
||||||
|
<p>В любом случае вам необходимо будет воспользоваться командой
|
||||||
|
<b>send-pr</b> для того, чтобы дать знать коммиттерам об изменении.
|
||||||
|
Если вы делаете это, проверьте, что поле "Category" установлено в
|
||||||
|
значение "docs" и что "Class" имеет значение "doc-bug" (если ваше
|
||||||
|
изменение решает проблему, например, опечатку) или "change-request"
|
||||||
|
(если вы добавляете новую информацию в существующий раздел).</p>
|
||||||
|
|
||||||
|
<p></p><a href="docproj.html">FreeBSD Documentation Project Home</a>
|
||||||
|
&footer
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
Loading…
Reference in a new issue