Глава 5. Другие файлы в каталоге debian/

gentoo for Debian
-----------------
<possible notes regarding this package - if none, delete this file>
 -- Josip Rodin <[email protected]>, Wed, 11 Nov 1998 21:02:14 +0100

Если вам нечего сюда написать, удалите этот файл. Смотрите dh_installdocs(1).

Бывает очень обидно, когда тратишь много времени и усилий на настройку программы, а при очередном обновлении все настройки исчезают. Debian предлагает решение этой проблемы через механизм пометки файлов как настроечных — conffiles ^[54]. Для таких файлов при обновлении пакета вам будет задан вопрос, нужно ли заменить старые файлы теми, что включены в новый пакет.

Программа dh_installdeb(1) автоматически помечает все файлы в каталоге /etc как файлы conffiles, так что, если у вашей программы есть файлы conffiles только там, вам не обязательно указывать их в этом файле. Для большинства типов пакетов единственное место (и для них так должно быть всегда), в котором содержатся файлы conffiles, это /etc и, таким образом, в этом файле нет необходимости.

Если ваша программа не только использует файлы настройки, но и изменяет их, будет лучше не отмечать их как conffiles, так как в этом случае dpkg каждый раз будет просить пользователя проверить изменения.

Если программа, которую вы упаковываете, требует от пользователя изменить файлы настройки в каталоге /etc, существует два популярных способа не отмечать их как conffiles, чтобы подавить вопросы со стороны dpkg:

Информацию о сценариях сопровождающего смотрите в Раздел 5.18, «Файлы {pre|post}{inst|rm}».

Файлы, указанные в файле install, не нуждаются в предварительном создании каталогов. Смотрите Раздел 5.11, «Файл install».

Для начала лучше попробовать запустить установку и использовать этот файл, только если есть проблемы. В начале имён каталогов, перечисляемых в файле dirs, косая черта не указывается.

Document: gentoo
Title: Gentoo Manual
Author: Emil Brink
Abstract: This manual describes what Gentoo is, and how it can be used.
Section: File Management
Format: HTML
Index: /usr/share/doc/gentoo/html/index.html
Files: /usr/share/doc/gentoo/html/*.html

Формат этого файла описан в справочной странице install-docs(8), а также в локальной копии руководства Debian по doc-base из пакета doc-base.

Подробная информация по установке дополнительной документации приведена в Раздел 3.3, «Установка файлов в их каталоги назначения».

If there are files that need to be installed into your package but your standard make install won't do it, put the filenames and destinations into this install file. They are installed by dh_install(1).^[55] You should first check that there is not a more specific tool to use. For example, documents should be in the docs file and not in this one.

В файле install для каждого устанавливаемого файла отводится одна строка; в ней задаётся имя файла (относительно верхнего каталога сборки), потом пробел, потом установочный каталог (относительно каталога установки). Например, если при установке не устанавливается src/bar, то файл install будет выглядеть так:

src/bar usr/bin

В результате после установки пакета в системе появится исполняемая команда /usr/bin/bar.

Также, в файле install можно указывать только имя файла без каталога установки, если не менялся относительный путь. Такой формат, обычно, используется для большого пакета, в котором результат сборки разбивается на несколько двоичных пакетов; список устанавливаемых файлов помещается в соответствующий файл пакет-1.install, пакет-2.install и т.д.

Если команда dh_install не находит файлы в текущем каталоге, то она ищет их в debian/tmp (или в любом другом месте, указанном в --sourcedir).

Файлы postinst, preinst, postrm и prerm ^[57] называются сценариями сопровождающего. Эти сценарии находятся в управляющей области пакета и запускаются программой dpkg при установке, обновлении или удалении пакета.

Как начинающему сопровождающему вам следует избегать ручной правки сценариев сопровождающего, так как они имеют тенденцию усложняться. Более подробную информацию смотрите в руководстве по политике Debian, глава 6 «Сценарии сопровождающего пакета и процесс установки», и взгляните на файлы примеров, предоставляемые dh_make.

Если вы не послушали меня и сделали собственные сценарии сопровождающего для пакета, вам следует убедиться, что вы сделали всё правильно, протестировав их не только для установки и обновления, но и для удаления и вычистки.

При обновлении пакета до новой версии на экран ничего не должно выводиться и это должен быть ненавязчивый процесс (пользователи не должны обращать внимание на обновление, за исключением обнаружения того, что старые ошибки были исправлены и, возможно, появились новые возможности).

Когда для обновления требуются какие-то действия (например, файлы настройки разбросаны по различным каталогам в домашнем каталоге с абсолютно разной структурой), вы можете перевести пакет в безопасное состояние (например, отключив службу) и предоставить соответствующую документацию, требуемую политикой (README.Debian и NEWS.Debian). Не беспокойте пользователя меню debconf, вызываемым из сценариев сопровождающего для обновления.

Пакет ucf предоставляет conffile-подобную инфраструктуру для сохранения пользовательских изменений в файлах, которые не могут быть помечены как conffiles, например файлы, управляемые сценариями сопровождающего. Это должно минимизировать возможные проблемы, связанные с ними.

Сценарии сопровождающего являются сильной стороной Debian, из-за них люди выбирают Debian. Вы должны быть очень осторожны, чтобы не превратить их в источник раздражения.

Packaging of a library is not easy for a novice maintainer and should be avoided. Having said it, if your package has libraries, you should have debian/package.symbols files. See Раздел A.2, «Управление debian/пакет.symbols».

The watch file format is documented in the uscan(1) manpage. The watch file configures the uscan program (in the devscripts package) to watch the site where you originally got the source. This is also used by the Debian Package Tracker service.

Вот его содержимое:

# управляющий файл watch для uscan
version=3
http://sf.net/gentoo/gentoo-(.+)\.tar\.gz debian uupdate

Обычно, с указанного в файле watch URL http://sf.net/gentoo скачивается страница и в ней ищутся ссылки вида <a href=...>. Базовое имя (часть за последним /) каждой найденной ссылки сравнивается с шаблоном регулярного выражения Perl (смотрите perlre(1)) gentoo-(.+)\.tar\.gz. Из совпавших файлов загружается файл с наибольшим номером версии и запускается программа uupdate, которая создаёт из них обновлённое дерево исходного кода.

Although this is true for other sites, the SourceForge download service at http://sf.net is an exception. When the watch file has a URL matching the Perl regexp ^http://sf\.net/, the uscan program replaces it with http://qa.debian.org/watch/sf.php/ and then applies this rule. The URL redirector service at http://qa.debian.org/ is designed to offer a stable redirect service to the desired file for any watch pattern of the form http://sf.net/project/tar-name-(.+)\.tar\.gz. This solves issues related to periodically changing SourceForge URLs.

Если автор программы подписывает tarball ключом, то рекомендуется проверять его подпись с помощью параметра pgpsigurlmangle как описано в uscan(1).

В новом формате пакетов с исходным кодом 3.0 (quilt) изменения записываются в виде серии заплат quilt в каталог debian/patches. Эти изменения автоматически накладываются в ходе распаковки пакета исходного кода ^[58]. Изменения Debian хранятся в архиве debian.tar.gz, содержащем все файлы из каталога debian. Новый формат позволяет сопровождающему включать двоичные файлы, такие как значки в формате PNG, без дополнительных ухищрений ^[59].

Когда программа dpkg-source распаковывает пакет с исходным кодом в формате 3.0 (quilt), она автоматически накладывает все заплаты, перечисленные в файле debian/patches/series. Вы можете избежать наложения заплат в конце распаковки, указав параметр --skip-patches.

Автоматически генерируемые файлы в дереве исходного кода могут немного раздражать при пакетировании, так как из-за них генерируются бесполезные большие файлы заплат. Для решения этой проблемы есть специальные модули, такие как dh_autoreconf, описанные в Раздел 4.4.3, «Доработка файла rules».

При создании пакета с исходным кодом вы можете указать регулярное выражение Perl в параметре --extend-diff-ignore для dpkg-source(1), чтобы игнорировать изменения в автоматически генерируемых файлах.

Общим решением этой проблемы с автоматически создаваемыми файлами является сохранение аргумента dpkg-source в файле пакета с исходным кодом source/options. Благодаря следующим настройкам в файлы заплат не будут включены config.sub, config.guess и Makefile.

extend-diff-ignore = "(^|/)(config\.sub|config\.guess|Makefile)$"

В новом формате 3.0 (quilt) заплаты хранятся в файлах debian/patches/*, для создания которых применяется команда quilt. Эти заплаты и другие данные пакета — всё содержимое каталога debian — упаковывается в файл debian.tar.gz. Так как команда dpkg-source может работать с данными quilt в формате 3.0 (quilt) без пакета quilt, то его не нужно включать в зависимости Build-Depends ^[60].

Работа с командой quilt описана в quilt(1). Она записывает изменения исходного кода в виде набора заплат -p1 в каталоге debian/patches, а дерево исходного кода вне каталога debian остаётся нетронутым. Порядок применения этих заплат указывается в файле debian/patches/series. Вы можете легко наложить (=push), откатить (=pop) или обновить заплаты ^[61].

В Глава 3, Изменение исходного кода мы создали 3 заплаты в debian/patches.

Поскольку заплаты Debian расположены в debian/patches, убедитесь, что программа dquilt настроена правильно, как было описано в Раздел 3.1, «Настройка quilt».

Позднее, когда кто-то (включая вас самих) предоставляет заплату foo.patch к исходному коду, изменить пакет исходного кода 3.0 (quilt) очень просто:

$ dpkg-source -x gentoo_0.9.12.dsc
$ cd gentoo-0.9.12
$ dquilt import ../foo.patch
$ dquilt push
$ dquilt refresh
$ dquilt header -e
... описание заплаты

Заплаты, хранимые в новом формате исходного кода 3.0 (quilt), должны быть без ненужного мусора. Вы должны убедиться в этом, запустив: dquilt pop -a; while dquilt push; do dquilt refresh; done.