Manjaro

PKGBUILD

Revision as of 13:39, 5 January 2023 by Krotesk (talk | contribs) (Created page with "=== noextract === Массив файлов, перечисленных в массиве {{ic|source}}, которые не должны извлекаться из их ар...")
Other languages:
English • ‎русский

PKGBUILD - это файл описания сборки пакетов Manjaro Linux (на самом деле это сценарий shell), используемый при создании пакетов.

Пакеты в Manjaro Linux собираются с помощью утилиты makepkg и информации, хранящейся в PKGBUILD. Когда запускается утилита makepkg, она ищет PKGBUILD в текущем каталоге и, следуя инструкциям в нем, компилирует или получает файлы для создания пакета (pkgname.pkg.tar.xz). Полученный пакет содержит двоичные файлы и инструкции по установке, которые легко устанавливаются с помощью pacman.

Переменные

Ниже перечислены переменные, которые могут быть заполнены в файле PKGBUILD. pkgname, pkgver, pkgrel и arch являются обязательными. license не является строго необходимым для сборки пакета, но рекомендуется для любых PKGBUILDS, которыми вы, возможно, захотите поделиться с другими. При его отсутствии makepkg выдает предупреждения.

Обычно принято определять переменные в PKGBUILD в том же порядке, который приведен здесь. Однако это не является обязательным, если используется правильный синтаксис Bash.

pkgname

Название пакета. Оно должно состоять из буквенно-цифровых и любого из следующих символов @ . _ + - (символ собака, точка, подчеркивание, плюс, дефис). Все буквы должны быть строчными, а имена не должны начинаться с дефиса. Для единообразия pkgname должно совпадать с именем исходного tarball'а программы, которую вы упаковываете. Например, если программа находится в foobar-2.5.tar.gz, значение pkgname должно быть foobar. Текущий рабочий каталог, в котором находится файл PKGBUILD, также должен соответствовать pkgname.

pkgver

Версия пакета. Значение должно совпадать с версией, выпущенной автором пакета. Оно может содержать буквы, цифры, точки и знаки подчеркивания, но НЕ МОЖЕТ содержать дефис. Если автор пакета использует дефис в своей схеме нумерации версий, замените его на знак подчеркивания. Например, если версия 0.99-10, ее следует заменить на 0.99_10. Если переменная pkgver используется позже в PKGBUILD, то подчеркивание можно легко заменить на тире при использовании, например: 

source=($pkgname-${pkgver//_/-}.tar.gz)

pkgrel

Номер выпуска пакета, характерный для Arch Linux. Это значение позволяет пользователям различать последовательные сборки одной и той же версии пакета. Когда новая версия пакета выпускается впервые - номер выпуска начинается с 1. По мере внесения исправлений и оптимизаций в файл PKGBUILD, пакет будет перевыпущен, а номер выпуска будет увеличен на 1. Когда выходит новая версия пакета - номер выпуска возвращается к 1.

pkgdir

Эта переменная отражает корневой каталог того, что будет помещено в пакет. Она обычно используется в make DESTDIR="$pkgdir" install.

epoch

Используется для того, чтобы заставить пакет считаться более новым, чем все предыдущие версии с более ранней датой выпуска, даже если номер версии обычно не вызывает такого обновления. Это значение должно быть положительным целым числом; если оно не указано, то по умолчанию равно 0. Это полезно, когда схема нумерации версий пакета меняется (или становится буквенно-цифровой), нарушая обычную логику сравнения версий. Дополнительные сведения о сравнении версий см. в pacman(8).

pkgbase

Необязательная глобальная директива доступна при сборке разделенного пакета, pkgbase используется для ссылки на группу пакетов в выводе makepkg и в именовании tarballs, содержащих только исходники. Если она не указана - используется первый элемент массива pkgname. Все опции и директивы для разделенных пакетов по умолчанию имеют глобальные значения, указанные в PKGBUILD. Тем не менее, следующие из них могут быть переопределены в функции упаковки каждого разделенного пакета: pkgver, pkgrel, epoch, pkgdesc, arch, url, license, groups, depends, optdepends, provides, conflicts, replaces, backup, options, install и changelog. Переменная не может начинаться с дефиса.

pkgdesc

Описание пакета. Описание должно быть не более 80 символов и не должно включать имя пакета в виде самоссылки. Например, "Nedit - текстовый редактор для X11" должно быть указано как "Текстовый редактор для X11".


Note
Не следуйте этому правилу бездумно при отправке пакетов в AUR. Если название пакета по каким-то причинам отличается от названия приложения - включение полного названия в описание может быть единственным способом гарантировать что пакет будет найден при поиске

.

arch

Массив архитектур, на которых, как известно, собирается и работает файл PKGBUILD. В настоящее время он должен содержать i686 и/или x86_64, arch=('i686' 'x86_64'). Значение any также может быть использовано для независимых от архитектуры пакетов.

Вы можете получить доступ к целевой архитектуре с помощью переменной $CARCH во время сборки и даже при определении переменных. См. также FS16352. Пример: 

depends=(foobar)
if test "$CARCH" == x86_64; then
  depends+=(lib32-glibc)
fi

url

URL-адрес официального сайта упаковываемого программного обеспечения.

license

Лицензия, по которой распространяется программное обеспечение. В licenses был создан пакет [core], хранящий общие лицензии в /usr/share/licenses/common, например, /usr/share/licenses/common/GPL. Если пакет лицензирован по одной из этих лицензий - значение должно быть установлено в имя каталога, например license=('GPL'). Если соответствующая лицензия не включена в официальный пакет licenses - необходимо выполнить несколько действий:

  1. The license file(s) should be included in: /usr/share/licenses/pkgname/, e.g. /usr/share/licenses/foobar/LICENSE.
  2. If the source tarball does NOT contain the license details and the license is only displayed elsewhere, e.g. a website, then you need to copy the license to a file and include it.
  3. Add custom to the license array. Optionally, you can replace custom with custom:name of license. Once a license is used in two or more packages in an official repository (including [community]), it becomes a part of the licenses package.
  • The BSD, MIT, zlib/png and Python licenses are special cases and could not be included in the licenses package. For the sake of the license array, it is treated as a common license (license=('BSD'), license=('MIT'), license=('ZLIB') and license=('Python')) but technically each one is a custom license because each one has its own copyright line. Any packages licensed under these four should have its own unique license stored in /usr/share/licenses/pkgname. Some packages may not be covered by a single license. In these cases, multiple entries may be made in the license array, e.g. license=('GPL' 'custom:name of license').
  • Additionally, the (L)GPL has many versions and permutations of those versions. For (L)GPL software, the convention is:
    • (L)GPL - (L)GPLv2 or any later version
    • (L)GPL2 - (L)GPL2 only
    • (L)GPL3 - (L)GPL3 or any later version
  • If after researching the issue no license can be determined, PKGBUILD.proto suggests using unknown. However, upstream should be contacted about the conditions under which the software is (and is not) available.



Tip
Некоторые авторы программ не предоставляют отдельный файл лицензии и описывают правила распространения в разделе общего ReadMe.txt. Эта информация может быть извлечена в отдельный файл на этапе build примерно следующим образом: sed -n '/This software/,/ thereof./p' ReadMe.txt > LICENSE.

groups

Группа, к которой принадлежит пакет. Например, когда вы устанавливаете пакет kdebase - он устанавливает все пакеты, входящие в группу kde.

depends

Массив имен пакетов, которые должны быть установлены до запуска этой программы. Ограничения по версии могут быть указаны с помощью операторов сравнения, например, depends=('foobar>=1.8.0'); если требуется несколько ограничений - зависимость может быть повторена для каждого из них [1], например, depends=('foobar>=1.8.0' 'foobar<2.0.0'). Вам не нужно перечислять пакеты, от которых зависит ваша программа, если другие пакеты, от которых зависит ваша программа, уже имеют эти пакеты в списке зависимостей. Например, gtk2 зависит от glib2 и glibc. Однако glibc не нужно указывать в списке зависимостей для gtk2, поскольку он является зависимостью для glib2.

optdepends

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

optdepends=(
  'cups: printing support'
  'sane: scanners support'
  'libgphoto2: digital cameras support'
  'alsa-lib: sound support'
  'giflib: GIF images support'
  'libjpeg: JPEG images support'
  'libpng: PNG images support'
)

makedepends

Массив имен пакетов, которые должны быть установлены для сборки программы, но не нужны для использования программы после установки. Вы можете указать минимальную зависимость версий пакетов в том же формате, что и массив depends.


Note
Указывать пакеты, которые уже находятся в depends, не обязательно.
Warning
Предполагается, что группа base-devel уже установлена при сборке с помощью makepkg. Участники "base-devel" не должны быть включены в массивы makedepends.

checkdepends

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

provides

Массив имен пакетов, функции которых предоставляет данный пакет (или виртуальный пакет, такой как cron или sh). Пакеты, предоставляющие одинаковые возможности, могут быть установлены одновременно, если они не конфликтуют друг с другом (см. ниже). Если вы используете эту переменную, то следует добавить версию (pkgver и, возможно, pkgrel), которую будет предоставлять этот пакет, если это может повлиять на зависимости. Например, если вы предоставляете модифицированный пакет qt под названием qt-foobar версии 3.3.8, предоставляемый qt, то массив provides должен выглядеть как provides=('qt=3.3.8'). Добавление provides=('qt') приведет к сбою тех зависимостей, которые требуют определенной версии qt. Не добавляйте pkgname в массив provides - это делается автоматически.

conflicts

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

replaces

Массив устаревших имен пакетов, заменяемые этим пакетом, например, replaces=('ethereal') для пакета wireshark. После синхронизации с pacman -Sy - он немедленно заменит установленный пакет, если в репозиториях встретится другой пакет с соответствующим replaces. Если Вы предоставляете альтернативную версию уже существующего пакета - используйте переменную conflicts, которая оценивается только при установке конфликтующего пакета.

backup

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

При обновлении новая версия может быть сохранена как file.pacnew, чтобы избежать перезаписи файла, который уже существует и был ранее изменен пользователем. Аналогично, при удалении пакета измененный пользователем файл будет сохранен как file.pacsave, если только пакет не был удален командой pacman -Rn.

Пути к файлам в этом массиве должны быть относительными (например, etc/pacman.conf), а не абсолютными (например, /etc/pacman.conf). См. также Arch Wiki по pacman/Pacnew and Pacsave.

options

Этот массив позволяет вам отменить некоторые параметры поведения по умолчанию makepkg, определенные в /etc/makepkg.conf. Чтобы установить опцию - включите имя опции в массив. Чтобы отменить поведение по умолчанию - поставьте символ ! перед опцией. В массив можно поместить следующие параметры:

  • strip - Strips symbols from binaries and libraries. If you frequently use a debugger on programs or libraries, it may be helpful to disable this option.
  • docs - Save /doc directories.
  • libtool - Leave libtool (.la) files in packages.
  • staticlibs - Leave static library (.a) files in packages
  • emptydirs - Leave empty directories in packages.
  • zipman - Compress man and info pages with gzip.
  • purge - Remove files specified by the PURGE_TARGETS variable from the package.
  • upx - Compress binary executable files using UPX. Additional options can be passed to UPX by specifying the UPXFLAGS variable.
  • ccache - Allow the use of ccache during build. More useful in its negative form !ccache with select packages that have problems building with ccache.
  • distcc - Allow the use of distcc during build. More useful in its negative form !distcc with select packages that have problems building with distcc.
  • buildflags - Allow the use of user-specific buildflags (CFLAGS, CXXFLAGS, LDFLAGS) during build. More useful in its negative form !buildflags with select packages that have problems building with custom buildflags.
  • makeflags - Allow the use of user-specific makeflags during build. More useful in its negative form !makeflags with select packages that have problems building with custom makeflags.

install

Имя сценария .install, который будет включен в пакет. pacman имеет возможность хранить и выполнять специфический для пакета скрипт при установке, удалении или обновлении пакета. Скрипт содержит следующие функции, выполняемые в разное время:

  • pre_install - Сценарий запускается непосредственно перед извлечением файлов. Передается один аргумент: новая версия пакета.
  • post_install - Скрипт запускается сразу после извлечения файлов. Передается один аргумент: новая версия пакета.
  • pre_upgrade - Скрипт запускается непосредственно перед извлечением файлов. Передаются два аргумента в следующем порядке: новая версия пакета, старая версия пакета.
  • post_upgrade - Скрипт запускается сразу после извлечения файлов. Два аргумента передаются в следующем порядке: новая версия пакета, старая версия пакета.
  • pre_remove - Скрипт запускается непосредственно перед удалением файлов. Передается один аргумент: версия старого пакета.
  • post_remove - Скрипт запускается сразу после удаления файлов. Передается один аргумент: старая версия пакета.

Каждая функция запускается под chroot внутри каталога установки pacman. См. эту тему.



Tip
Прототип .install предоставлен в /usr/share/pacman/proto.install.

changelog

Имя журнала изменений пакета. Чтобы просмотреть журналы изменений для установленных пакетов (у которых есть этот файл): 

pacman -Qc pkgname



Tip
Прототип файла changelog (журнала изменений) представлен в /usr/share/pacman/ChangeLog.proto.

source

Массив файлов, необходимых для сборки пакета. Он должен содержать расположение источника программного обеспечения, который в большинстве случаев представляет собой полный HTTP или FTP URL. Здесь можно эффективно использовать ранее установленные переменные pkgname и pkgver (например, source=(http://example.com/$pkgname-$pkgver.tar.gz)).


Note
Если вам нужно предоставить файлы, которые нельзя загрузить на лету, например, самодельные патчи, вы просто помещаете их в тот же каталог, в котором находится ваш файл PKGBUILD, и добавляете имя файла в этот массив. Любые пути, которые вы добавляете сюда, определяются относительно каталога, в котором лежит PKGBUILD. Перед началом процесса сборки все файлы, указанные в этом массиве, будут загружены или проверены на существование и makepkg не будет продолжен, если какой-либо из них отсутствует.



Tip
Вы можете указать другое имя для загруженного файла - если загруженный файл по какой-то причине имеет другое имя, например, в URL был параметр GET - используя следующий синтаксис: filename::fileuri, например $pkgname-$pkgver.zip::http://199.91.152.193/7pd0l2tpkidg/jg2e1cynwii/Warez_collection_16.4.exe

noextract

Массив файлов, перечисленных в массиве source, которые не должны извлекаться из их архивного формата с помощью makepkg. Чаще всего это относится к архивам, которые не могут быть обработаны /usr/bin/bsdtar, потому что libarchive обрабатывает все файлы как потоки, а не как случайный доступ, как это делает unzip. В таких ситуациях альтернативный инструмент разархивирования (например, unzip, p7zip и т.д.) должен быть добавлен в массив makedepends, а первая строка функции prepare() должна извлечь исходный архив вручную; например: 

unzip [источник].zip

Обратите внимание, что в то время как массив source принимает URL, noextract - это просто часть имени файла. Так, например, вы можете сделать что-то вроде этого (упрощенно из grub2's PKGBUILD): 

source=("http://ftp.archlinux.org/other/grub2/grub2_extras_lua_r20.tar.xz")
noextract=("grub2_extras_lua_r20.tar.xz")

Чтобы извлечь ничего - Вы можете сделать что-то вроде этого (взято из firefox-i18n): 

noextract=(${source[@]%%::*})


Note
Более консервативная замена в Bash будет включать кавычки или, возможно, даже цикл, вызывающий basename. Если Вы дочитали до этого места, то должны понять идею.

md5sums

Массив контрольных сумм MD5 файлов, перечисленных в массиве source. Когда все файлы в массиве source будут доступны - MD5-хэш каждого файла будет автоматически сгенерирован и сравнен со значениями этого массива в том же порядке, в котором они появляются в массиве source. Хотя порядок исходных файлов сам по себе не имеет значения - важно, чтобы он совпадал с порядком этого массива, поскольку makepkg не может угадать, какая контрольная сумма принадлежит какому исходному файлу. Вы можете быстро и легко сгенерировать этот массив с помощью команд updpkgsums или makepkg -g в каталоге, содержащем файл PKGBUILD.

Note
Алгоритм MD5, как известно, имеет недостатки - Вам следует рассмотреть возможность использования более надежной альтернативы

.

sha1sums

Массив 160-битных контрольных сумм SHA-1. Это альтернатива md5sums, описанной выше, но она также известна своими недостатками, поэтому Вам следует рассмотреть возможность использования более сильной альтернативы. Чтобы включить использование и генерацию этих контрольных сумм обязательно установите опцию INTEGRITY_CHECK в /etc/makepkg.conf. См. man makepkg.conf.

sha256sums, sha384sums, sha512sums

Массив контрольных сумм SHA-2 с размерами дайджеста 256, 384 и 512 бит соответственно. Это альтернатива описанным выше md5sums и, как правило, считается более надежной. Чтобы включить использование и генерацию этих контрольных сумм, обязательно установите опцию INTEGRITY_CHECK в /etc/makepkg.conf. См. man makepkg.conf.

Смотрите также

Retrieved from "https://wiki.manjaro.org/index.php?title=PKGBUILD/ru&oldid=40252"