Во-первых, спасибо, что вы нашли время и сделали это.
+ +Вы должны сделать вашу документацию доступной для предварительного + просмотра. Если это возможно, поместите ее на FTP или веб. Если у + вас нет собственного FTP или веб-пространства, закачайте вашу + документацию в каталог ftp://ftp.FreeBSD.ORG/pub/FreeBSD/incoming/ + и воспользуйтесь командой send-pr (как это описано ниже), чтобы + кто-нибудь из коммиттеров сделал ее общедоступной.
+ +После этого пошлите сообщение в список рассылки -doc с кратким + описанием документации и ссылкой на ее местоположение а также + требованием поделиться комментариями.
+ +Скорее всего, вы еще должны будете сделать cc: этого запроса на + комментарии в другие подходящие списки рассылки. Например, что-либо, + относящееся к использованию CVSup для синхронизации дерева исходных + текстов, будет интересно подписчикам списков рассылки + FreeBSD-current и FreeBSD-stable.
+ +После того, как люди посмотрели на вашу документацию, и вы получили + шанс включить в документ любые из их пожеланий, вы готовы послать + эту документацию.
+ +Чтобы сделать это, заархивируйте ее в один tar-файл. Если ваша
+ документация состоит из трех файлов,
+
+
+ % tar cf doc.tar one two three
+
+
+
Затем выполните сжатие tar-файла,
+ ++ % gzip -9 doc.tar ++ +
в результате чего появится doc.tar.gz.
+ +После этого вы должны закачать файл /pub/FreeBSD/incoming/.
+ +Теперь дайте знать о нем группе Documentation Project. Правильным + способом сделать это является использование команды send-pr, + которая должна быть установлена на вашей машине.
+ +Вы делаете это для того, чтобы ваше послание могло быть отслежено. + Когда вы оформляете PR (Problem Report - сообщение о проблеме), ему + назначается уникальный номер. Один из коммиттеров может затем + направить PR себе, и установить с вами связь по поводу включения + новой документации в систему.
+ +send-pr сама по себе очень проста. Все, что она делает - это + посылка электронной почты, оформленной особым образом, на определенный + адрес. Когда вы запускаете send-pr, вы оказываетесь в + текстовом редакторе (вероятнее всего, vi или emacs) с + бланком для заполнения и некоторыми инструкциями по заполнению.
+ +Удостоверьтесь, что пункт "Category" установлен в "docs", а "Class" + в одно лишь "change-request". И не забудьте указать имя файла, которое + вы закачали, чтобы коммиттеры могли его найти!
+ +Когда вы завершите работу с редактором, PR будет послано по + электронной почте туда, куда нужно. Вскоре вы получите подтверждающее + сообщение, вкратце говорящее, какой номер был назначен PR, и этот + номер может быть использован для отслеживания его судьбы.
+ +Как альтернативу вы можете использовать веб-интерфейс по адресу http://www.freebsd.org/send-pr.html.
+ +И снова благодарим вас за то, что вы потратили на это время.
+ +Прежде всего вам нужно сгенерировать особый файл, называемый + diff. В этом diff-файле содержатся только изменения, которые + вы внесли. Это облегчает персоне, выполняюшей внесение изменений в + систему, просмотр ваших изменений, что означает ненужность траты + массы времени на объяснения, что конкретно было изменено (хотя вы + должны будете объяснить, почему эти изменения так необходимы).
+ +Чтобы сделать 'diff', вы должны;
+ +Сделать копию файла, который собираетесь менять. Если вы
+ изменяете
+
+
+ % cp foo.sgml foo.sgml.old
+
Затем внесите ваши изменения в foo.sgml
+ ++ % vi foo.sgml + ... клац клац клац ... + + ... тестируем изменения, ищем опечатки, и тому подобное ... +
Делаем diff. Команда, это делающая
+ ++ % diff -c foo.sgml.old foo.sgml > foo.diff ++ +
Здесь выполняется просмотр отличий между двумя файлами и запись + этих отличий в файл
После этого вы можете послать + +
Вы можете поместить файл ftp://ftp.FreeBSD.ORG/pub/FreeBSD/incoming/ + или, если он достаточно маленький (скажем, вы просто исправляете + опечатку), вы можете включить diff непосредственно в PR, в раздел + "Fix:".
+ +В любом случае вам необходимо будет воспользоваться командой + send-pr для того, чтобы дать знать коммиттерам об изменении. + Если вы делаете это, проверьте, что поле "Category" установлено в + значение "docs" и что "Class" имеет значение "doc-bug" (если ваше + изменение решает проблему, например, опечатку) или "change-request" + (если вы добавляете новую информацию в существующий раздел).
+ + FreeBSD Documentation Project Home +&footer + +