Как использовать dpatch

Для полноты картины с пересборкой Debian–пакетов (см. мой предыдущий пост) решил перевести статью об использовании тулзы для менеджмента патчей — dpatch.

Эта статья является переводом поста
Сандро Тоси (Sandro Tosi) “HowTo use dpatch”

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

Правильный Путь заключается в создании набора патчей, которые должны применяться к апстримовому коду при создании пакета; это позволит diff.gz содержать только изменения внутри директории debian/, что есть Хорошо.

Популярным инструментом для управления патчами при создании пакетов является dpatch.

0. Базовые вещи

Прежде всего нужно установить dpatch:

# apt-get install dpatch

и добавить dpatch в поле Build-Depends в файле debian/control. Более того, нужно создать директорию debian/patches: это место, где хранятся патчи.

В этой же директории будет файл debian/patches/00list: он будет содержать список имён патчей и они будут применены в том порядке, в котором упоминаются в этом файле.

1. Создание патча

Поставленный ранее пакет содержит полезную утилиту — dpatch-edit-patch:

• заходим в директорию с исходниками пакета
• выполняем
  dpatch-edit-patch <имя_патча>

Будет создана копия директории с исходниками пакета, после чего будет запущен дочерний шелл; делайте свои правки и выходите из шелла (Сделать это можно с помощью команды exit. Если хотите покинуть шелл, не сохраняя сделанных правок, выполните exit 230. Прим. переводчика). После этого будет создан патч debian/patches/имя_патча, в который будут записаны все ваши правки.

Не забудьте обновить debian/patches/00list.

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

2. Конвертирование патча

Этот скрипт (спасибо Чарльзу Плесси (Charles Plessy)) принимает на вход модифицированный и оригинальный файлы, создаёт патч в универсальном формате и затем конвертирует его в формат dpatch'а.

diff -u первоначальные-исходники/файл модифицированные-исходники/файл | \
dpatch patch-template -p "<номер>_<краткое_описание>" \
"<что делает патч>" > путь/к/debian/patches/<номер>_<краткое_описание>.dpatch

(замените <теги> на подходящие значения).

Обычно патч (по большей части тот, который присылается через систему отслеживания багов) представляет собой файл: для того, чтобы его сконвертировать, замените diff -u ... на cat /путь/к/файлу.patch — и всё.

3. Тестирование патча

Окей, вы только что сотворили патч, но как проверить, что он делает то, что должен? Примените его!

Из распакованного пакета исходного кода (рабочей копии для создания пакета) выполните

dpatch apply-all

а для отмены

dpatch deapply-all

4. Использование dpatch в debian/rules

Осталось только дописать debian/rules таким образом, чтобы патчи из debian/patches/ применялись в порядке, указанном в debian/patches/00list.

Думаю, самым простым способом будет модифицирование debian/rules следующим образом:

include /usr/share/dpatch/dpatch.make

...
build: build-stamp
build-stamp: patch-stamp
...
build stuff here
...

clean: unpatch
...
clean stuff here
...
...

Но если хотите, можете отдельно добавить цели patch и unpatch, как показано в следующем примере:

build-stamp: patch
...
build stuff here
...

clean: clean1 unpatch
clean1:
...
clean stuff here
...

patch: patch-stamp
patch-stamp:
dpatch apply-all -v
#dpatch call-all -a=pkg-info >patch-stamp

unpatch:
dpatch deapply-all
rm -rf patch-stamp debian/patched

binary: binary-indep binary-arch
.PHONY: build clean binary-indep binary-arch binary install patch unpatch \
clean1

В любом случае, советую следовать первому способу, так как он чище и более устойчив к ошибкам.

5. Восстановление первоначального апстримового кода

Самой первой вещью, которую должен запомнить каждый сопровождающий пакетов Debian, является: НИКОГДА не менять апстримовый код в своём пакете; вместо этого должны использоваться патчи. Даже если вы следуете этому Руководящему Правилу при создании своих пакетов, вы можете столкнуться с изменениями апстримового кода, когда будете усыновлять пакет.

Существует способ сконвертировать такие изменения (сделанные предыдущим сопровождающим пакета) в патч для dpatch:

• используя apt-get source <пакет> или какую–либо другую команду, получите пакет исходников; будем считать, что он будет распакован в директорию с именем <пакет-версия> — перейдите в неё (заметим, что исходный файл будет в родительской директории)
• измените debian/rules так, как показано в предыдущей секции этой статьи
• используйте dpatch-convert-diffgz: эта утилита берёт .diff.gz, извлекает изменения, выполненные над апстримовым кодом, и конвертирует их в файл dpatch, который будет применяться во время сборки пакета

Если вы управляете своими пакетами старым способом (без контроля версий исходного кода), работа завершена. Я использую Subversion, чтобы управлять своими пакетами, и это требует нескольких дополнительных шагов:

• скачиваете пакет с исходными кодами с зеркала репозитория Debian
• распаковываете его во временную директорию <tempdir> (или позвольте apt-get source сделать это для вас)
• импортируйте в репозиторий SVN (будет произведена проверка рабочей директории — <workdir>)
• переходите в <tempdir> и меняете debian/rules (после чего выполняете то же самое в <workdir>)
• выполняете dpatch-convert-diffgz 01 restore_pristine_code (можете выбирать любое имя); будут созданы файлы debian/patches/01_restore_pristine_code.dpatch и debian/patches/00list
• перемещаете оба вышеупомянутых файла в <workdir> и добавляете их в репозиторий
• возвращаете назад апстримовый код, модифицированный предыдущим сопровождающим; это может означать копирование файлов руками (cp -p ....) из распакованного апстримового тарболла, либо выполнение fakeroot debian/rules patch ; fakeroot debian/rules unpatch (действенность последнего способа не гарантируется)

Это немного сложно, но таким образом вы сможете «усыновить» пакет и использовать dpatch, что есть хорошо.

Копируете статью — поставьте ссылку!