Как написать ebuild

Это руководство о том, как начать писать ebuild-файлы, чтобы использовать возможности Portage для установки и управления ещё большим количеством программного обеспечения.

Вы можете написать ebuild-файл для установки какого-либо программного обеспечения в Gentoo, если нет подходящих существующих ebuild-файлов. Это относительно простая задача, и это единственный способ чисто и аккуратно установить большинство «сторонних» программ в системе. ebuild-файл позволяет менеджеру пакетов отслеживать каждый файл, установленный в систему, чтобы обеспечить корректное обновление и удаление.

После того, как ebuild-файл заработал, им можно поделиться, отправив его в запросе на слияние, или в отдельный репозиторий ebuild-файлов и сделав его общедоступным. С небольшими затратами можно вносить предложения и сопровождать ebuild-файлы в репозитории GURU.

Репозитории ebuild-файлов

Чтобы ebuild-файлы были видны Portage, они помещаются в репозиторий ebuild-файлов, который настроен для Portage через /etc/portage/repos.conf (общую информацию о работе с репозиториями ebuild-файлов см. в разделе Управление репозиторием).

Создайте репозиторий ebuild-файлов для экспериментов, следуя этому руководству. В данной статье будет использоваться пример репозитория в /var/db/repos/example_repository.

eselect repository упрощает создание репозитория:

Заметка
Ebuild-файлы можно установить с помощью команды ebuild, однако это не рекомендуется — эта команда предназначена только для целей разработки. В этой статье будет использоваться команда ebuild с ebuild-файлом для тестирования во время разработки, но в других случаях обязательно используйте команду emerge с ebuild-файлом в репозитории.

Как создать ebuild-файл

Короче говоря, ebuild-файлы — это просто текстовые файлы. Все, что нужно, чтобы начать писать ebuild-файлы — это текстовый редактор, чтобы предоставить возможность устанавливать пакеты программ для Gentoo.

Заметка
В этом разделе {CATEGORY}, {PN} и {P} представляют категорию пакета, имя пакета и имя пакета и версию соответственно, и являются стандартными переменными, используемыми в ebuild-файлах. Вместе эти переменные могут представлять указатель версии.

Некоторые редакторы имеют опциональную функцию создания ebuild-файлов, в этом случае переходите к соответствующему разделу. В противном случае для более быстрого начала работы можно использовать каркас («шаблон»).

Начните с каркаса

If the editor does not have integrated ebuild functionality to help to start off, there is a skeleton ebuild file (skel.ebuild) located in the Gentoo ebuild repository. To start with that file as a base, simply copy it to an appropriate location (nano is used as the text editor in this example):

Vim

There is a vim plugin to automatically start from a skeleton when creating an empty ebuild file.

After installing app-vim/gentoo-syntax, create the appropriate directory for the ebuild, then launch vim with a new «{P}.ebuild» filename provided on the command line, to be automatically met with a basic skeleton that can be modified and saved:

Emacs

Демонстрация на примере

This example will create an ebuild for scrub, version 2.6.1 (if it didn’t already exist), to show how a typical process might go.

Create a directory to house the ebuild, in the ebuild repository created earlier:

Change the shell working directory to the new path:

This example will use Vim to create the ebuild file and provide a skeleton to serve as a basis to write the ebuild on, but use editor of choice (see previous section about using Emacs, or the skeleton file):

Файл scrub-2.6.1.ebuildРедактирование нового файла в vim с шаблона

# Copyright 1999-2023 Gentoo Authors
# Distributed under the terms of the GNU General Public License v2
 
EAPI=8
 
DESCRIPTION="Some words here"
HOMEPAGE="https://github.com/chaos/scrub"
SRC_URI="https://github.com/chaos/scrub/releases/download/2.6.1/scrub-2.6.1.tar.gz"
 
LICENSE="GPL-2"
SLOT="0"
KEYWORDS="~amd64 ~x86"
IUSE=""
 
DEPEND=""
RDEPEND="${DEPEND}"
BDEPEND=""


This— with the omission of those lines with =""— is the minimum information necessary to get something that will work.  Ebuilds inheriting certain eclasses might come with a different set of minimal information, e.g. ant-jsch-1.10.9.ebuild. Save the file — voila an ebuild, in it’s most basic form,it’s that simple!


 Заметка
Using the ${PN} variable inside SRC_URI is allowed, though this is not necessarily best practice. While it may be shorter to type, there is some reasoning on why not to use it that may be worth consideration.


Код avoid using PN as such
SRC_URI="https://github.com/gentoo/${PN}/releases/download/${PV}/${P}.tar.gz"
# Reads better as, e.g.
SRC_URI="https://github.com/gentoo/gentoo/releases/download/${PV}/${P}.tar.gz"




See this ebuild file format policy guide page for more recommendations.

It is possible to test fetching and unpacking the upstream sources by the new ebuild, using the ebuild command:


root #ebuild ./scrub-2.6.1.ebuild manifest clean unpack

Appending /var/db/repos/example_repository to PORTDIR_OVERLAY...
>>> Downloading 'https://ftp.halifax.rwth-aachen.de/gentoo/distfiles/scrub-2.6.1.tar.gz'
--2019-06-03 16:42:57--  https://ftp.halifax.rwth-aachen.de/gentoo/distfiles/scrub-2.6.1.tar.gz
Resolving ftp.halifax.rwth-aachen.de... 137.226.34.46, 2a00:8a60:e012:a00::21
Connecting to ftp.halifax.rwth-aachen.de|137.226.34.46|:443... connected.
HTTP request sent, awaiting response... 200 OK
Length: 362536 (354K) [application/octet-stream]
Saving to: '/usr/portage/distfiles/scrub-2.6.1.tar.gz.__download__'
 
/usr/portage/distfiles/scrub-2.6.1.tar.gz.__download__             100%[==============================================================================================================================================================>] 354.04K  --.-KB/s    in 0.08s   
 
2019-06-03 16:42:58 (4.24 MB/s) - '/usr/portage/distfiles/scrub-2.6.1.tar.gz.__download__' saved [362536/362536]
 
 * scrub-2.6.1.tar.gz BLAKE2B SHA512 size ;-) ...                                                                                                                                                                                                                  [ ok ]
>>> Unpacking source...
>>> Unpacking scrub-2.6.1.tar.gz to /var/tmp/portage/app-misc/scrub-2.6.1/work
>>> Source unpacked in /var/tmp/portage/app-misc/scrub-2.6.1/work



This should download and unpack the source tarball, without error, as in the example output.




  


                       
  




For some exceptionally simple packages like this one, that do not need patching or other more advanced treatment, the ebuild may work just so — with no further adjustments needed.

For best practice, the test suite may be run at this stage — this is particularly true when starting out:


root #ebuild scrub-2.6.1.ebuild clean test install

To actually install the new ebuild on the system, run:


root #ebuild scrub-2.6.1.ebuild clean install merge

Patching upstream source in an ebuild

The source can be patched at installation time, to adapt to Gentoo specificities for example, by setting up patches from an ebuild.

Put the patches in the right directory:


user $cd /var/tmp/portage/app-misc/scrub-2.6.1/work/scrub-2.6.1/

A patch can be created from the unpacked source code as explained in the Creating a patch article. Patches should then be listed in an array called PATCHES as explained in the devmanual:




  


                       
  





Код Patches will be applied during src_prepare
PATCHES=(
	"${FILESDIR}"/${P}-foo.patch
	"${FILESDIR}"/${P}-bar.patch
)
 
src_prepare() {
    default
    ...
}



QA testing


Use pkgcheck (dev-util/pkgcheck) to check for QA errors in an ebuild:


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

GitHub Pull Requests — how to contribute to Gentoo by creating pull requests on GitHub.
java-ebuilder — an experimental package being developed by Gentoo Java developers to generate initial ebuilds from Maven pom.xml files.
Notes on ebuilds with GUI
Project:GURU — an official repository of new Gentoo packages that are maintained collaboratively by Gentoo users
Project:Proxy_Maintainers/User_Guide/Style_Guide
Project:Python — страницы проекта Python содержат информацию про создание ebuild-файлов для пакетов, написанных на Python
Project:X11/Ebuild_maintenance
Proxied Maintainer FAQ
Test environment
Writing go Ebuilds‎‎ — a short reference, intended to be read alongside Basic guide to write Gentoo Ebuilds and the go-module.eclass documentation

Внешние ресурсы

Gentoo Policy Guide
Quickstart Ebuild Guide
Gentoo Development guide
Michał Górny: Category: Ebuild writing
Michał Górny: The ultimate guide to EAPI 7
Michał Górny: The ultimate guide to EAPI 8
man 1 ebuild — The ebuild command’s man page.
man 5 ebuild — The ebuild file format man page.
The skel.ebuild
Adding new packages via proxy-maint project

Если у вас нет желаемого пакета Gentoo, не бойтесь! Вы можете построить свой собственный! Для этого вам понадобится некоторый опыт компиляции программного обеспечения с использованием известных инструментов Linux make, gcc и других. Чтобы создать пакет Gentoo, emake используется для управления и настройки процесса. Используя эти инструменты, вы можете создавать очень тонкие пакеты, которые работают быстро и надежно.

Структура Ebuild

Чтобы создать свой собственный ебилд, вы должны начать с правильного *.файл ebuild. Ваш файл ebuild — это сердце всего вашего ebuild. Файл ebuild зависит от многих других файлов, как и make. Фактически, в большинстве случаев ваш ebuild будет зависеть от make, хотя это ваш выбор. Вот дерево неовим:
/ mnt / SW / projects / System / Gentoo / gentoo / редакторы приложений / neovim
├── файлы
│ ├── neovim-0.4.3-gcc-10-исправить.пластырь
│ ├── neovim-0.4.4-cmake_luaversion_patch
│ ├── neovim-0.4.4-cmake-релиз-тип.пластырь
│ └── sysinit.vim
├── Манифест
├── метаданные.xml
├── неовим-0.4.4-r100.ебилд
└── neovim-9999.ебилд

Итак, для чего вы используете эти файлы в своем приложении?? *.файл ebuild — очевидный файл. Этот файл содержит SRC_URI, который напрямую указывает на код. Другая информация в файле включает описание, веб-сайт и дополнительную информацию, необходимую для компиляции пакета.

Файл манифеста содержит хэш, который однозначно идентифицирует код.

Метаданные.xml содержит имя и адрес электронной почты сопровождающего, название проекта и несколько флагов для компиляции. Удаленное удостоверение также находится в этом файле, как и репозиторий GitHub для восходящего потока. Каталог файлов содержит любые патчи, которые могут вам понадобиться, и любые специальные настройки, которые вам нужны. В приведенном выше примере показан файл с соответствующими настройками по мнению специалистов по сопровождению Gentoo.

Внутри файла Ebuild

Значения внутри файла по большей части легко понять. Описание и домашняя страница предназначены для помощи разработчикам. Номер EAPI указывает, какая версия Gentoo будет запущена. У вас также есть Лицензия, что совершенно ясно; сопоставьте Лицензию с кодом, для которого вы создаете файл ebuild.

Еще сложнее SLOT, который используется, если вам нужно иметь несколько версий. Затем SLOT укажет эту сборку на версию, которую вы поддерживаете. Большинство программного обеспечения будет иметь значение 0, что позволяет одновременно использовать только одну версию.

KEYWORDS — это значение, указывающее, для каких платформ можно компилировать исходный код. Это amd65, x86 и, возможно, arm64. Полный список доступен в вашей системе Gentoo. Обратите внимание: если вы хотите внести свой вклад, вы должен установите тильду (~) перед архитектурой. Это означает, что код не протестирован, поэтому убедитесь, что код хорошо протестирован, прежде чем удалять этот символ. Желательно, чтобы многие пользователи просматривали код перед удалением тильды.

Переменная IUSE возвращает параметры, которые вы хотите установить для своего компилятора.

У вас также есть DEPEND, который бывает трех разных типов. Значения RDEPEND — это значения, которые вы используете при запуске кода. Значения BDEPEND являются значениями, зависящими от сборки. Пакет, который вы пытаетесь добавить в Gentoo, будет содержать файл с описанием необходимых зависимостей.

Для простых пакетов больше ничего не нужно. Однако в конкретном пакете, над которым вы работаете, вероятно, будут некоторые вещи, которые необходимо сделать перед компиляцией кода. Если это не соответствует ожиданиям разработчиков Gentoo, вы можете настроить свой собственный.

Функции

В файле установщик будет использовать определенные функции для всего процесса. Например, чтобы применить исправления перед запуском команды, src_prepare () функция справится с этой ситуацией.

В src_configure () функция использует econf для установки, я.е., ‘use_enable.’В этой функции вы можете распаковать свои файлы с помощью команды unpack. Вы также можете передавать аргументы в ./ configure для вашего проекта, используя эконф. Как видите, эти функции названы в соответствии с их эквивалентами make, и часто они передают аргументы через.

В src_install () функция выполняет ту же функцию, что и делать установить будет делать в сборке C / C ++. Тем не менее, он содержит множество параметров, которые вы можете найти в справочном документе.

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

Пример: файл пакета SimulIDE

Здесь мы представляем файл, который был создан для пакета SimulIDE. Для пакета требуется среда разработки Qt5, поэтому вам нужно будет добавить ее в свой файл ebuild. На следующем изображении вы можете увидеть значения RDEPEND, отражающие эту идею. Библиотеки уже содержатся в репозиториях Gentoo, что позволяет легко указать на.

# Copyright 2021 Матс Таге Аксельссон
# Распространяется на условиях GNU General Public License v3
EAPI = 7
DESCRIPTION = «SimulIDE моделирует ваши схемы, включая эмуляцию Arduino.»
HOMEPAGE = «https: // www.симулид.com / p / home.html «
SRC_URI = «https: // mailfence.com / pub / docs / santigoro / web / SimulIDE_0.4.14 / simulide_0.4.14-SR4_Sources.деготь.gz «
ЛИЦЕНЗИЯ = «GPL-3»
SLOT = «0»
KEYWORDS = «~ x86 ~ amd64»
RDEPEND = «dev-qt / qtsvg
dev-qt / qtxml
dev-qt / qtscript
dev-qt / qtwidgets
dev-qt / qtconcurrent
dev-qt / qtserialport
dev-qt / qtmultimedia «
DEPEND = «$ RDEPEND
dev-библиотеки / libelf
dev-embedded / avr-libc «
src_prepare ()
распаковать simulide_0.4.14-SR4_Sources.деготь.gz

src_configure ()
econf —with-popt

в src_prepare () функция, вы можете увидеть, что пакет распаковывается перед использованием.

Оверлей

Когда вы исправили все свои ошибки, вы можете добавить свой пакет в проект Gentoo. Layman был создан для того, чтобы вы могли использовать экспериментальное программное обеспечение для установки основного дистрибутива. Проект называется Overlays, но команда для его установки называется Layman.

Заключение

Создание новых пакетов для Gentoo — это задача, которая может расширить ваши возможности. Даже в этом случае, если вы собрали много пакетов перед использованием make и набора инструментов gcc, вы сможете довольно быстро освоить этот процесс. Кроме того, не забудьте внести свой вклад в сообщество как можно больше.

Время на прочтение
5 мин

Количество просмотров 4.4K

Привет, #{username}!

Сегодня я хочу написать об одной маленькой проблеме и её решении. Проблема касается пользователей Linux, у которых после одного из последних обновлений стал падать Galculator. Не могу ручаться за достоверность информации, но похоже, что каким-то магическим образом это касается только пользователей Gentoo (но далеко не всех). Проблема неприятная, а решение оказалось очень простым. В официальном portage Galculator перестанет падать только через некоторое время, т.ч. пока можно воспользоваться моим решением.

Чтобы хоть как-то наполнить статью интеллектуальностью, я на примере конкретной проблемы покажу:
1. Как сделать свой ebuild-файл.
2. Как организовать своё хранилище ebuild’ов. Оно пригодится как раз при подобном случае, ставшем темой для статьи.

Кроме того, я был бы рад, если бы гентоо-менторы подсказали мне, где почитать о том, как вести себя в подобной ситуации. Куда лучше постить патчи к ebuild’ам (и стоит ли это делать вообще), как оформлять эти патчи, какие есть особенности оформления и т.д.

Заранее скажу, что статья окажется полезной и интересной только тем, кто уже по крайней мере уже собрал себе систему самостоятельно.

Описание проблемы

Для начала вот линк на баг #463459 в Gentoo Bugzilla: тынц.
Проблема воспроизводится не у всех. У меня — отлично воспроизводится.

Проблема заключается в том, что при попытке выполнить некоторые операции в Galculator, последний падает. Gdb даёт такой backtrace.

Сначала я грешил на множественные emerge критичных пакетов без пересборки мира. Но потом обстоятельства всё же меня припёрли к стенке и мир я пересобрал. Калькулятор всё равно падал.

Гугление быстро вывело меня на страницу по ссылке выше. В конце обсуждения Simon — один из maintainer’ов Galculator — сообщал о том, что переписал ту часть кода, которая одновременно использовала malloc и g_free (т.е. функции выделения памяти, находящиеся в разных библиотеках). Память под объекты выделялась функциями одной библиотеки, а освобождалась функциями другой. Выглядело правдоподобно. Сообщение сразу после подтверждало, что проблема была именно в этом (строго говоря, это нельзя считать доказанным; воспринимайте по-дефолту как «скорее всего»). Однако релиза калькулятора до сих пор нет, стало бы и нету нового ebuild’а.

Однако ещё до этого опытным путём выяснили, что отключение библиотеки quadmath решает проблему. Это, честно говоря, вызывает удивление, но на моей машине подтвердилось. Плохо то, что сам пакет Galculator позволяет собирать себя без quadmath, а ebuild эту возможность не использует. У него вообще нет ни одного USE флага. Ситуация тупиковая и глупая: есть SVN, в котором лежит рабочая версия; есть даже флаг, скормив который скрипту configure, можно избавиться от проблемы магическим образом. Но нет возможности воспользоваться ни одной из этих возможностей, не выходя за рамки системы сборки Gentoo…

Решение проблемы или как чукча стал писателем

Решения нет только в том случае, если вы только пользуетесь тем, что даёт репозиторий Gentoo. Однако, если вы хоть немного владете Shell’ом и умеете находить ответы на вопросы в стуктурированной документации, то проблема решаема.

«А почему бы мне не взять и поправить ebuild файл для Galculator, добавив в него нужную функциональность?» — подсказывает внутренний голос.

Не стоит это делать. При следующем emerge —sync ваши изменения перетрутся. Интуиция подсказывает, что должна быть возможность создать локальную «песочницу» билдов. И такая возможность действительно имеется.

Если вы ещё не знаете, что такое layman, то прочтите о нём. Всё достаточно просто. При установке layman’а у вас появляется дополнительный репозиторий ебилдов, работающий по несколько другой схеме, нежели production репозиторий. Подробное обяснение того, что такое layman и overlay, не входит в мои платы. Для решения нашей проблемы достаточно знать, что, после установки layman, вы смело можете создать свою папку /usr/local/portage/#{username} и скидывать туда свои сборки, перетирать их никто не станет.

В данном случае решение проблемы выглядит следующим образом:

mkdir /usr/local/portage/#{username}
cp -rv /usr/portage/sci-calculators/galculator /usr/local/portage/#{username}
cd /usr/local/portage/#{username}/galculator
edit galculator-2.1.3.ebuild
ebuild galculator-2.1.3.ebuild digest
emerge --unmerge galculator
emerge -av #{username}/galculator

Из приведённых команд прокомментирую только две.

edit — данная команда вызывает не какой-то конкретный редактор. Она вызывает редактор, указанный в переменной окружения EDIT. Если у вас до сих пор не настроена эта переменная и вы не пользуетесь командой edit, то часть вины за глобальное потепление лежит и на вас!

ebuild galculator-2.1.3.ebuild digest — этой командой мы подписываем наши исправления, чтобы подтвердить, что исправления произошли не из-за проблем с ЖД или эффектом случайного редактирования конфигов.

Теперь о том, что конкретно надо писать в ebuild файл. По-хорошему, надо было бы выпустить целую статью о том, как писать ebuild файлы. И я рад был бы, если бы кто-то за меня это сделал. С радостью почитал бы. Но, увы, пока такой доступной и, вместе с тем, грамотной статьи я не видел. Посему приходится пользоваться оригинальной, от производителя. Она, впрочем, для чуть более продвинутого пользователя оказалась бы не плохой. Мне же пока придётся привести здесь просто код того, что надо вставить.

Изначально ebuild Galculator’а не содержит ни одной инструкции сборки. Все выполняется в default-манере. Нам нужно поменять метод конфигурирования. Для этого мы добавим в файл функцию src_configure(), которая вызывается как раз для конфигурирования пакета.

src_configure() {
	gnome2_src_configure $(use_enable quadmath)
}

ebuild’ы представляют собой просто Shell-скрипты. Существуют опредедённые соглашения о том, в каком формате эти скрипты пишутся. Сводятся эти соглашения в конечном итоге к трём вещам:
1. Какой перечень функций должен быть объявлен в файле, какая функция в какой момент вызывается и для чего она предназначена.
2. Какие переменные должны быть определены в файле, каковы их имена и что они означают (когда и как они используются).

Кроме того, конечно, у нас есть библиотеки, реализующие шаблонные действия. econf — вызвать configure скрипт, elog — вывести сообщение в лог сборки и т.д.

В данном случае мы пользуемся функцией gnome2_src_configure вместо стандартной econf. По всей видимости все пакеты из коллекции gnome2 имеют схожие методы конфигурирования и для них написали функцию, которая внутри уже вызывает econf. Я обнаружил это просто посмотрев ebuild похожего по набору используемых библиотек пакета.

Нашей основной задачей является добавление возможности собрать с опцией «—disable—quadmath». —disable-*, —enable-*, —with-* и —without-* — стандартные опции configure. Поэтому для них должны быть готовые обёртки. И они есть. Для enable/disable есть одна обёртка — use_enable. Эта функция вернёт —enable-#{flag}, если «flag» был установлен в списке USE-флагов при сборке, и —disable-#{flag} в противном случае. То, что надо. Осталось только сообщить в описании списка используемых пакетом флагов, что наш пакет использует флаг quadmath и по-умолчанию значение этого флага — disable. Делается это так:

IUSE="-quadmath"

Готово.

Послесловие

На самом деле, Gentoo — очень крупная, строго организованная организация. Как и любая крупная, не молодая организация, она имеет много общепринятых вещей, с которыми трудно познакомиться, читая мануалы. Там описано что-то, но далеко не всё. Разработчик Gentoo — это фактически должность. Разработчику предоставляют рабочую почту, рабочий аккаунт на сервере и много других удобных инструментов. Одна процедура принятия в разработчики стоит целой статьи, если бы были люди, которым это оказалось интересно.

Я уже год как пересел с LFS-дистрибутива на Gentoo и недавно окончательно определился, что это то, что мне надо. Поэтому я хочу стать активным участником сообщества Gentoo. Если на хабре есть Gentoo-менторы, я был бы признателен за возможность взять меня под свой патронаж для вступления в Gentoo Developers.

Удачи!