Замечание: Оригинал этого документа новее, чем перевод.

CVS Проекта документирования Debian

Web-страницы и многие руководства Проекта Документирования Debian (Debian Documentation Project) располагаются на CVS-сервере Debian cvs.debian.org.

Загружать исходные файлы с CVS-сервера может кто угодно. Однако, обновлять файлы могут только члены Проекта документирования Debian.

Доступ к исходным файлам в CVS-репозитории

Вы можете использовать интерфейс viewCVS для доступа к отдельным файлам через WWW и просматривать изменения в них по адресу http://cvs.debian.org/?cvsroot=debian-doc.

Для загрузки целого документа, как правило, лучше использовать прямой доступ к CVS-серверу. Вам нужно установить на своей машине пакет cvs.

Анонимное соединение (только для чтения) с CVS-сервером

Чтобы соединиться, введите команду:

cvs -d :pserver:anonymous@cvs.debian.org:/cvs/debian-doc login

и в ответ на приглашение ввести пароль просто нажмите Enter.

После соединения вы можете использовать обычные команды CVS (см. info-страницы CVS), чтобы извлечь файлы, но не можете изменять и регистрировать изменения в них.

Чтобы загрузить файлы в первый раз, создайте каталог, где они будут храниться, и перейдите в него. В этом каталоге будут созданы два подкаталога: CVS и ddp.

Для загрузки всех файлов используйте эту команду:

cvs -d :pserver:anonymous@cvs.debian.org:/cvs/debian-doc -z3 checkout ddp/manuals.sgml

Она рекурсивно создаст и заполнит каталоги.

Чтобы обновить вашу локальную копию, внеся в неё изменения, сделанные другими людьми, войдите в каталог ddp/manuals.sgml и выполните команду:

cvs -z3 update -d -P

После того, как вы завершили сеанс удалённой работы с CVS, используйте для отсоединения от сервера команду:

cvs logout

Соединение с CVS-сервером с правами на изменение

Перед использованием этого способа доступа к CVS-серверу вы должны получить право на изменение файлов на сервере. Пожалуйста, прочтите, как отправить соответствующий запрос.

Чтобы соединиться, введите команду:

cvs -d :pserver:идентификатор@cvs.debian.org:/cvs/debian-doc login

и введите пароль, согласованный с координатором документации. В команде замените идентификатор вашим именем пользователя на сервере паролей CVS. Оно не обязательно совпадает с вашим именем на cvs.debian.org, если оно у вас есть.

Вы можете использовать обычные команды CVS (см. info-страницы CVS) для извлечения файлов и регистрации изменений в них.

Чтобы загрузить файлы в первый раз, создайте каталог, где они будут храниться, и перейдите в него. В этом каталоге будут созданы два подкаталога: CVS и ddp.

Для загрузки всех файлов используйте команду:

cvs -d :pserver:идентификатор@cvs.debian.org:/cvs/debian-doc -z3 checkout ddp/manuals.sgml

Она рекурсивно создаст и заполнит каталоги.

Чтобы обновить вашу локальную копию, внеся в неё изменения, сделанные другими людьми, войдите в каталог ddp/manuals.sgml и выполните команду:

cvs -z3 update -d -P

После того, как вы завершили сеанс удалённой работы с CVS, используйте для отсоединения от сервера команду:

cvs logout

Соединение с CVS-сервером с правами на изменение с помощью SSH

Этот способ могут использовать только зарегистрированные разработчики Debian. По сравнению с pserver, описанным выше, он является предпочтительным. Если вы только что стали зарегистрированным разработчиком Debian, пожалуйста, уведомите об этого координатора документации, чтобы он удалил вашу учётную запись pserver.

Чтобы подсоединиться по ssh, сперва сообщите об этом CVS:

export CVS_RSH=ssh

Затем создайте каталог, где будут храниться файлы, перейдите в него и выполните команду:

cvs -d :ext:идентификатор@cvs.debian.org:/cvs/debian-doc -z3 checkout модуль

В команде замените идентификатор вашим именем пользователя на сервере паролей CVS. Это то же самое имя, что и на всех машинах Debian. Замените модуль названием модуля, который вы хотите загрузить, обычно это ddp/manuals.sgml. Далее у вас запросят пароль на CVS-сервере. Не путайте его с паролем на вашей машине.

В этом каталоге будут созданы два каталога, CVS и ddp. CVS рекурсивно создаст любые запрошенные вами модули (т.е. каталоги) и заполнит их файлами.

Вы можете использовать обычные команды CVS (см. info-страницы CVS) для извлечения файлов и регистрации изменений в них.

Чтобы обновить вашу локальную копию, перейдите в каталог ddp/manuals.sgml и запустите команду:

cvs -z3 update -d -P

Как получить права на обновление

Права на обновления доступны любому, кто хочет помогать в написании руководств. Обычно мы просим, чтобы вы сначала прислали несколько полезных обновлений.

Чтобы получить права на обновление, отправьте запрос в список рассылки Документация Debian. Объясните в запросе, зачем вам нужен доступ. Перед тем, как вы получите доступ, ваш запрос должен одобрить Координатор документирования либо другой ответственный член Команды документирования. После того, как ваш запрос одобрен, попросите того, кто его одобрил, отправить запрос (подписанный) в список debian-admin.

Если вы являетесь разработчиком Debian, после одобрения запроса вы будете добавлены в группу cvs_doc на сервере cvs.debian.org и с этого момента сможете регистрировать изменения в CVS.

Если вы не разработчик, после одобрения вашего запроса вы должны будете представить имя пользователя и пароль. Имя пользователя не должно совпадать с названием какой-либо уже существующей учётной записи Debian (проверьте это по базе db.debian.org). Пароль нельзя пересылать по почте не зашифрованым (хотя сама система cvs не шифрует его при передаче по сети).

Для шифрования пароля вы можете использовать программу makepasswd. Для этого установить соответствующий пакет и выполните команду:

$ echo "SECRET" |makepasswd --clearfrom=- --crypt

Другой простой способ зашифровать пароль — использовать Perl (если он установлен на вашей машине):

$ perl -e "printf \"%s\n\", crypt ("SECRET", join ('', ('.', '/', 0..9, 'A'.. 'Z', 'a'..'z')[rand (64), rand (64)]))"

Пожалуйста, отправьте то, что получилось, вместе с выбранным именем пользователя, Мартину Шульцу (Martin Schulze). Зашифруйте письмо целиком его ключом GnuPG.

Более подробную информацию см. на странице информации по регламенту.


Организация файлов

Этот рисунок показывает структуру дерева каталогов CVS:

Дерево каталогов CVS-репозитория DDP

Пожалуйста, обратите внимание, что web-сайт DDP размещен в модуле webwml CVS-репозитория Debian, для интеграции с остальными web-страницами Debian.


Механизм автоматического обновления

Web-страницы текстов руководств генерируются на www-master.debian.org заданием cron каждый день после 15:39 по тихоокеанскому времени.

Скрипт запускает cvs update -d -P, а затем make -C manuals.sgml clean publish, оба в каталоге ddp.

Управляющий файл make настроен на пересборку каждого подкаталога (которые содержат проектируемую документацию), и установку файлов из каждого подкаталога в подкаталог doc/manuals/ web-сайта. Файлы make в подкаталогах взяты из ddp/manuals.sgml/standard.makefile.

Файлы документации, созданные скриптом обновления, можно найти по адресу http://www.debian.org/doc/manuals/.

Журналы сообщений скрипта обновления можно найти по адресу http://www-master.debian.org/build-logs/ddp/