Часть вторая, в которой рассматриваются вопросы работы с SVN для начинающих:

Использование Subversion

Структура репозитория Subversion

Если все предыдущие шаги пройдены успешно, то вы готовы к использованию вашего репозитория. В комлекте Subversion поставляется интерфейс для командной строки, который так и называется: svn.

# Получить справку по использованию
[root@name] svn --help

Основные команды, которые вам нужно знать это svn import (импорт исходников в репозиторий), svn commit (ci) (обновление репозитория с учетом сделанных вами изменений), и svn checkout (co) (загрузка рабочей копии файлов к вам на локальную машину или в локальную директорию). Итак, сначала import чтобы поместить исходники в svn, затем checkout чтобы получить полную актуальную версию и наконец, после правок и изменений – commit для сохранения внесенных вами изменений.

Перед тем как мы продолжим, несколько слов о структуре репозитория. Едва ли не все источники говорят о создании определенной структуры директорий в репозитории. В особенности они отмечают что необходимо создать директории branches, tags, и trunk в корневой директории репозитория. Например:

.
|-- project1
|   |-- branches
|   |-- tags
|   `-- trunk
`-- project2
|-- branches
|-- tags
`-- trunk

Далее в литературе описано как организовать работу с таким репозиторием. Надо сказать что такая структура не является обязательной и если у вас не очень сложный проект вы можете ей не следовать.

От переводчика. К слову сказать, я работал как с описанной в литературе структурой, так и без нее. Собственно если разработчиков 1-3, можно обойтись без усложнения процедур и репозитория. Если команда 5 и более человек, проект быстро растет и развивается, то заранее надо подумать о том как будут работать 10, 20 или даже 100 разработчиков.

В качестве примера, создадим тестовые директории и несколько файлов в них.

[root@name] cd /tmp
[root@name] mkdir mytestproj
[root@name] cd mytestproj
[root@name] mkdir configurations options main
[root@name] vim configurations/testconf1.cfg
[root@name] vim options/testopts1.cfg
[root@name] vim main/mainfile1.cfg

Имейте в виду, что вы можете создать любую нужную вам структуру директорий. Когда у вас есть структура проекта и несколько файликов, мы можем приступить к импортированию их в репозиторий.

Импорт в Subversion

[root@name] svn import /tmp/mytestproj/
file:///var/www/svn/repos/mytestproj
-m "Initial repository layout for mytestproj"
Adding         /tmp/mytestproj/main
Adding         /tmp/mytestproj/main/mainfile1.cfg
Adding         /tmp/mytestproj/configurations
Adding         /tmp/mytestproj/configurations/testconf1.cfg
Adding         /tmp/mytestproj/options
Adding         /tmp/mytestproj/options/testopts1.cfg

На самом деле импортировать можно не только через file:///var/www/svn/repos/mytestproj (этот прием подразумевает что репозиторий и ваши файлы находятся на одном сервере), но и указывая URL: http://yoursvnserver/repos/mytestproj. Этот же URL будет использован для выгрузки далее.

Выгрузка из Subversion

Теперь, легким движением руки… о чем это я… )) В общем давайте заберем из репозитория то что мы туда положили. Но сперва откройте в браузере http://yourmachine/repos. Однажды импортировав проект в SVN, вы можете использовать его на любой другой машине. Для соединения с репозиторием, вы также будете использовать аккаунт пользователя, созданного в первой части данной статьи:

[root@name] cd /tmp
[root@name] svn co http://yoursvnserver/repos/mytestproj
Authentication realm: <http://yoursvnserver:80> Subversion repos
Password for 'youruser':
A    mytestproj/main
A    mytestproj/main/mainfile1.cfg
A    mytestproj/configurations
A    mytestproj/configurations/testconf1.cfg
A    mytestproj/options
A    mytestproj/options/testopts1.cfg
Checked out revision 1.

Правка и коммит в Subversion

На предыдущем шаге мы выгрузили 1ю ревизию нашего проекта. Теперь вы можете отредактировать что-нибудь и закоммитить (commint) ваши правки обратно на сервер Subversion:

[root@name] cd mytestproj
[root@name] vim configurations/testconf1.cfg -- Add or delete something and save.
[root@name] svn commit -m "Added a line to testconf1.cfg."
Sending        configurations/testconf1.cfg
Transmitting file data .
Committed revision 2.

От переводчика: обратите внимание, с ключом -m добавляется текстовый комментарий (в данном случае “Added a line to testconf1.cfg.”). Комментарий не является обязательным, но я рекомендую не пренебрегать данной возможностью, это очень облегчает понимание изменений сделанных ранее другим разработчиком или вами, но несколько месяцев назад. Об этом еще будет сказано ниже.

В общем-то теперь вы можете удалить локальные файлы, так как правку вы внесли и закоммитили. Теперь ваши изменения можно посмотреть через браузер в репозитории. Тем не менее как правило так не делают, так как работают с файлами проекта несколько дней, недель, а то и месяцев.

Добавление и удаление в Subversion

Теперь, когда у нас все тип-топ, неожиданно нам требуется добавить файлы в наш репозиторий. Сделать это несложо используя аргумент add. Выгружаем наш проект, копируем новые файлы, добавляем их к репозиторию и коммитим изменения:

# Выгружаем
[root@name] svn co http://yoursvnserver/repos/mytestproj
A    mytestproj/main
A    mytestproj/main/mainfile1.cfg
A    mytestproj/configurations
A    mytestproj/configurations/testconf1.cfg
A    mytestproj/options
A    mytestproj/options/testopts1.cfg
Checked out revision 2.

# Добавляем файл
[root@name] cd mytestproj
[root@name] cp /etc/yum.repos.d/CentOS-Base.repo configurations/
[root@name] svn add configurations/CentOS-Base.repo
A         configurations/CentOS-Base.repo

# Коммитим правку
[root@name] svn commit -m "Added the CentOS Yum repo file."
Adding         configurations/CentOS-Base.repo
Transmitting file data .
Committed revision 3.

Удалить элементы также просто – только используйте delete а не add. И не забывайте коммитить изменения! Теперь, если вы зайдете через браузер в репозиторий, вы увидите что ревизия уже 3я.

Откат в Subversion

Описанное выше смотрится здорово, но что, если потребуется откатиться назад, к предыдущей версии? Это тоже несложно сделать. Если вы не уверены, какая версия вам нужна, команда log вам в помощь. Вот зачем очень желательно добавлять комментарии к каждому коммиту. Информации в комментарии не много, но достаточно для того чтобы понять что было сделано.

От переводчика: кстати полезно к комментарию добавлять номер бага или требования, по которому вносится данная правка (конечно если у вас используется багтрекинговая система или система управления требованиями), например “bug 1234: new directory added”

# Лог по всему репозиторию
[root@name] svn log http://yoursvnserver/repos
# Лог по выбранному проекту
[root@name] svn log http://yoursvnserver/repos/mytestproj

Таким образом вы получили полный список ревизий с комментариями. На основании списка вы можете выбрать нужную вам ревизию.

# Выгрузка первой ревизии
[root@name] svn co -r 1 http://yoursvnserver/repos/mytestproj

Контроль доступа (ACL)в Subversion

Зачастую, вам не потребуется разграничивать доступ пользователей к каждому репозиторию. Тем не менее, если это потребуется, то доступы пользователям можно разграничивать при помощи списков контроля доступа (ACLs). Данные списки можно подключить при помощи директивы AuthzSVNAccessFile, параметром которой служит имя файла:

# Включение ACLs
AuthzSVNAccessFile /etc/svn-acl-conf

Вы можете добавить эту директиву в секцию Location, соответствующую вашему репозиторию:

DAV svn
SVNParentPath /var/www/svn/repos
AuthzSVNAccessFile /etc/svn-acl-conf
AuthType Basic
AuthName "Subversion repos"
AuthUserFile /etc/svn-auth-conf
Require valid-user

Теперь необходимо создать файл /etc/svn-acl-conf. Он будет содержать секции следующего вида:

[reponame:repopath]
user = access

Параметр access может быть: r (read – чтение), rw (read-write – чтение-запись), или пустой (нет доступа). По умолчанию, при использовании ACLs, пользователи не имеют доступа к репозиторию. Предположим, что у нас есть репо framework, и мы хотим выдать следующие права: john – чтение, joe – чтение-запись. Это можно сделать при помощи следующей записи:

[framework:/]
john =  r
joe = rw

Также можно создавать группы в секции groups. В дальнейшем при использовании перед именами групп ставится @, например:

[groups]
staff = joe, george

[framework:/]
john =  r
@staff = rw

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

[/]
* = r

В качестве заключения

В данной статье освещена малая часть всех возможностей, которые Subversion может вам предложить. Этот краткий курс молодого svn-бойца предназначен помочь начинающим сориентироваться как что и зачем. Пользуйтесь документацией, там содержится множество полезных фич и приемов, которые будут полезны как одному разработчику, так и большой, в том числе и распределенной географически, команде. Вы также можете использовать Subversion для своих локальных нужд, указывая file:///path/to/repo вместо того чтобы работать через apache http://yoursvnserver/repos/whatever.

Удачи! )

Что еще почитать о Subversion?

Version Control with Subversion ака svnbook: http://svnbook.red-bean.com/

P.S.
Про установку и настройку SVN вы сможете прочитать в первой части – Subversion на CentOS 4.x/5.x и RHEL 4/5. Часть 1 – установка и настройка.

Часть первая, в которой рассматривается установка и настройка SVN через mod_dav:

Системы

Данное руководство применимо к CentOS 4.x/5.x и Red Hat Enterprise (RHEL) 4/5

Ссылки

Subversion: http://subversion.tigris.org/
Version Control with Subversion ака svnbook: http://svnbook.red-bean.com/

Установка

[root@name]$ yum install mod_dav_svn subversion

Устанавливаем перечисленные выше пакеты. Если у вас еще не утсанавлен apache, то его также необходимо установить. При устновке из yum, также могут устанавливаться дополнительные пакеты, в зависимости от вашей системы и установленных ранее пакетов.

Конфигурация Subversion

Apache

Перед тем как мы углубимся в дебри, нужно убедиться что у вас есть и сконфигурирован apache. В первую очередь откроем /etc/httpd/conf/httpd.conf и как минимум поменяем ServerName. Если это не помогает ))) то сверьтесь с официальной документацией по apache (http://httpd.apache.org)

[root@name] vim /etc/httpd/conf/httpd.conf
[root@name] service httpd start
[root@name] chkconfig httpd on

Проверьте работает ли веб-сервер, для этого достаточно открыть http://yourmachine в браузере. Работает? Отлично, впереди нас ждут более забавные вещи.

Конфигурация Apache для Subversion

Далее нужно сконфигурировать несколько вещей, чтобы apache и subversion могли работать вместе. Открываем примерный файл конфигурации, который шел вместе с пакетом subversion:

[root@name] cd /etc/httpd/conf.d/
[root@name] vim subversion.conf

# Убедитесь что эти две строки раскоментированы
# это значит apache будет загружать данные модули
LoadModule dav_svn_module     modules/mod_dav_svn.so
LoadModule authz_svn_module   modules/mod_authz_svn.so

Добавьте или подредактируйте следующие строки для базовой аутентификации и указания места расположения репозиториев

<Location /repos>
DAV svn
SVNPath /var/www/svn/repos
AuthType Basic
AuthName "Subversion repos"
AuthUserFile /etc/svn-auth-conf
Require valid-user
</Location>

Локация – это строка запроса, которая будет передаваться apache через URL, например http://yourmachine/repos указывает на SVNPath, который вы указали. Пример выше не является истиной первой инстанции, поэтому данные параметры вы можете настраивать как вам угодно (да, и не забывайте сохранять файл после того как отредактируете его)))).

Далее нам надо создать файл с паролями для аутентификации (этот файл мы уже прописали в конфигурации выше). Мы воспользуемся для этого утилитой htpasswd. В первый раз ее надо запускать с параметрами -cm. При этом будет создан новый файл и пароль будет зашифрован при помощи алгоритма MD5. Далее нужно использовать только ключ -m.

[root@name] htpasswd -cm /etc/svn-auth-conf yourusername
New password:
Re-type new password:
Adding password for user yourusername
[root@name] htpasswd -m /etc/svn-auth-conf anotherusername
New password:
Re-type new password:
Adding password for user anotherusername

Конфигурирование репозитория

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

[root@name] cd /var/www/
[root@name] mkdir svn
[root@name] cd svn
[root@name] svnadmin create repos
[root@name] chown -R apache:apache repos
[root@name] service httpd restart

Протестируйте репозиторий через браузер http://yourmachine/repos. Сначала должно отобразиться окошко с запросом имени и пароля. После успешной аутентификации должна отобразиться страница ревизии 0. Если все было именно так, значит наш репозиторий настроен. Если нужно много репозиториев, обратитесь к документации в начале данной статьи. Ну чтож, приступим к использованию нашего репозитория )

P.S.
Про работу с SVN вы сможете прочитать во второй части – Subversion на CentOS 4.x/5.x и RHEL 4/5. Часть 2 – работа с svn.

• наш проект (все-равно какой) в SVN репозитории;
• внешняя библиотека (нашей или сторонней разработки).

Задача:

• прозрачно для разработчика иметь up to date копию библиотеки в проекте.

Решение:

Пусть для определенности библиотеки у нас хранятся в директории lib/vendor относительно корня проекта. Выполняем команды

И в открывшемся редакторе (у меня vim) добавляем следующую строку:

Здесь:

• dirname это имя директории в которую будет развернута библиотека
• svn://url.to.the/library/repository – соответственно URL репозитория (http, https, svn)

Сохраняем изменения и фиксируем их в репозитории. После этого можно выполнять

Будет создана директория lib/vendor/dirname и в нее развернут код из указанного нами URL. Теперь при обновлении проекта будет обновляться и билиотека.

Хинт: если при выполнении svn propedit вылетает ошибка вида

Значит у вас не установлена переменная, указывающая какой редактор должен использовать svn. Смотрим где у нас vim и задаем требуемое значение переменной:

Как выяснилось после некоторого общения с SVN, $Id:$ таг не работает по умолчанию. Для того чтобы его использовать, нужно добавить следующий property для файла:

Для tortoisesvn делаем так:

- выбираем properties проекта

- прописываем параметр:

Ну и не забываем про commit после этих действий.

Неприятный момент при этом – что для новых файлов нужно properties прописывать заново. Как сделать для tortoisesvn это значение дефолтным, увы не знаю (если знаете – пишите ).

(UPD) Ура! Теперь я знаю как настраивать конфиг TortoiseSVN. Все просто: открываем контекстное меню, выбираем пункт Settings -> General -> “Subversion configuration file” -> кнопка Edit. Открывается текстовый конфиг SVN, который можно поправить в соответствии с тем что указано в начале данной темы.

Итак, с такой настройкой мы можем писать в коде строку:

/**
* @version SVN: $Id:$
*/

Которая после коммита преобразуется в такую:

/**
* @version SVN: $Id: actions.class.php 38 2008-05-22 21:27:23Z hudson $
*/

Have fun