Lua Policy: различия между версиями

Текущая версия от 12:51, 5 июля 2021

Черновик политики Sisyphus

Автор(ы) — ildar@

Обсуждение в devel@

Обсуждается с 06.10.2017

Правила упаковки модулей и программ на языке Lua.

Список интерпретаторов Lua в ALT Linux

Lua 5.1
Lua 5.3
LuaJIT 2.1 (совместим с Lua 5.1)

Для ясности стоит также упомянуть, что:

фактически транслятор языка находится в библиотеке и предоставляется пакетами liblua5.x и libluajit
программа /usr/bin/lua из пакета lua5.x является только средством для запуска скриптов Lua и чистых-Lua-программ (как тот же LuaRocks).
каждая из веток (5.3 и 5.1) у нас независимы от интерпретатора до дерева модулей. Ситуации, когда зависимости пакетов пересекают границы веток, считаются ошибкой.

Общие соображения

Программы Lua могут исполняться в двух режимах:

Какая-то программа, которая содержит в себе интерпретатор Lua (например, в виде библиотеки liblua.so.*), запускает Lua-подпрограмму посредством этого интерпретатора
Скрипт Lua запускается с помощью программы-интерпретатора, /usr/bin/lua

Следовательно, всё-таки стоит отойти от практики явной линковки модулей Lua с liblua.so и воспринимать эту библиотеку не как библиотеку, а как интерпретатор.

Модули Lua (как чистые-Lua, так и *.so) следует паковать через LuaRocks. Это позволяет полуавтоматически отслеживать зависимости между модулями и, в крайнем случае, доустанавливать модули пользователям в локальном режиме.

О версиях Lua и их модулях

Давным-давно в ALT Linux была одна только Lua 5.0 . С тех пор у нас стандартными путями для модулей были %_datadir/lua5 и %_libdir/lua5 . Потом вышла Lua 5.1 и версию 5.0 выкинули. Сейчас у нас 3 интерпретатора, реализующих две версии языка: 5.3 и 5.1 . Одним из критичных вопросов примем вопрос востребованности (интерпретаторов, модулей, ...).

Понятно, что каждый из интерпретаторов востребован теми пакетами, которые от них зависят, как какой-нибудь love работает на libluajit.so, поэтому в его зависимостях это прописано явно
Для модулей у нас есть зависимости их друг от друга и от версии Lua (пример?). Вопрос востребованности (т.е. вопрос: для какой версии Lua нужны модули?) открывается очень простым. На самом деле в 95% случаев подходит Lua >= 5.1. Это позволяет принять версию 5.3 главной в вопросе поддержки модулей и их упаковки.
Необходимо сохранить возможность упаковки модулей для определённых версий Lua, а также обеспечить максимальное облегчение сборки таких модулей

Главная версия

Главной версии интерпретатора у нас не будет, версии работают независимо

Правила упаковки модулей Lua

Модули и Lua-библиотеки следует паковать через LuaRocks. Это позволяет полуавтоматически отслеживать зависимости между модулями и в крайнем случае доустанавливать модули пользователям в локальном режиме.

Правила упаковки модулей:

Модуль пакуется для определённой ветки Lua (например, 5.3). При необходимости, модуль можно собрать для разных веток. Упаковка для разных веток полностью независима.
Именование модулей: lua%{версия_Lua}-module-имямод
Модули устанавливаются в пути %_datadir/lua/%{версия_Lua} (noarch) и %_libdir/lua/%{версия_Lua} (arch)
Модули собираются в RPM из rockspec при помощи утилиты lrimport. При желании возможна сборка без помощи этой утилиты.
Зависимости между модулями выглядят так: luarocks%{версия_Lua}(имямод) <>= вермод
Каждый пакет с модулем должен предоставлять: Provides: luarocks%{версия_Lua}(имямод) = %EVR

Правила упаковки программ, которые работают на /usr/bin/lua

Программы, имеющие в shebang #!/usr/bin/lua или #!/usr/bin/env lua, будут запускаться интерпретатором, на который ссылается /usr/bin/lua, т.е. на текущий момент lua-5.3

Отсюда следующие рекомендации:

(как правило), если у программы есть привязка к версии интерпретатора, то это надо указать в shebang, например, #!/usr/bin/lua5.1 или #!/usr/bin/lua5.3
если у программы есть зависимость на модули lua, то необходимо их добавить в зависимости, учитывая версию интерпретатора (например, luarocks5.3(luasocket) или luarocks5.1(luasocket))

Архитектуры LuaJIT

Во избежание поддержки списка ExclusiveArch вручную предлагается применять rpm-macros-luajit:

BuildRequires(pre): rpm-macros-luajit

ExclusiveArch: %luajit_arches

Нерешенные проблемы

lrimport не является полностью автоматизированным средством. Патчи приветствуются.
Вследствие того, что в сборочную среду невозможно установить одновременно liblua5.3-devel и liblua5.1-devel, сборка двоичных модулей из одного SRPM под два интерпретатора пока невозможна

Ссылки

@@ Строка 18: / Строка 18: @@
 * фактически транслятор языка находится в библиотеке и предоставляется пакетами ''liblua5.x'' и ''libluajit''
 * программа ''/usr/bin/lua'' из пакета ''lua5.x'' является только средством для запуска скриптов Lua и чистых-Lua-программ (как тот же LuaRocks).
+* каждая из веток (5.3 и 5.1) у нас независимы от интерпретатора до дерева модулей. Ситуации, когда зависимости пакетов пересекают границы веток, считаются ошибкой.
 == Общие соображения ==
@@ Строка 39: / Строка 40: @@
 == Главная версия ==
-Главной версией интерпретатора принимаем последнюю, 5.3. Это значит, что:
+Главной версии интерпретатора у нас не будет, версии работают независимо
-# Модули, упакованные в пакеты ''lua-module-имямод'' — это модули для Lua 5.3; зависимости вида ''luarocks(имямод)'' — это зависимости модулей для Lua 5.3
-# Программы, у которых в shebang <code>#!/usr/bin/lua</code> или <code>#!/usr/bin/env lua</code>, будут исполняться программой /usr/bin/lua из пакета ''lua5.3''
-# Если программа или модуль совместимы с Главной версией интерпретатора, то достаточно их упаковки для этой версии
-Замечания:
-* Версия 5.3 является главной начиная ALT Linux p9 и Sisyphus
-* На самом деле пакет liblua5.x, содержащий интерпретатор Главной версии, имеется в каждой инсталляции ALT Linux
 == Правила упаковки модулей Lua ==
@@ Строка 52: / Строка 46: @@
 Модули и Lua-библиотеки следует паковать через LuaRocks. Это позволяет полуавтоматически отслеживать зависимости между модулями и в крайнем случае доустанавливать модули пользователям в локальном режиме.
-Правила упаковки модулей для [[#Главная версия|Главной версии]]:
+Правила упаковки модулей:
-# Вся инфраструктура luarocks и модули собираются для Главной версии Lua (на данный момент 5.3)
+# Модуль пакуется для определённой ветки Lua (например, 5.3). При необходимости, модуль можно собрать для разных веток. Упаковка для разных веток полностью независима.
-# Именование модулей: ''lua-module-имямод''
+# Именование модулей: ''lua%{версия_Lua}-module-имямод''
-# Модули устанавливаются в пути ''%_datadir/lua/5.3'' (noarch) и ''%_libdir/lua/5.3'' (arch)
+# Модули устанавливаются в пути ''%_datadir/lua/%{версия_Lua}'' (noarch) и ''%_libdir/lua/%{версия_Lua}'' (arch)
-# Модули собираются в RPM из ''rockspec'' при помощи утилиты [http://git.altlinux.org/people/ildar/public/?p=lrimport.git lrimport].
+# Модули собираются в RPM из ''rockspec'' при помощи утилиты [http://git.altlinux.org/people/ildar/public/?p=lrimport.git lrimport]. При желании возможна сборка без помощи этой утилиты.
 # Зависимости между модулями выглядят так: ''luarocks%{версия_Lua}(имямод) <>= вермод''
-# Также пакет с модулем для Главной версии должен содержать ''Provides: luarocks(имямод)''
+# Каждый пакет с модулем должен предоставлять: ''Provides: luarocks%{версия_Lua}(имямод) = %EVR''
-Пояснения:
+== Правила упаковки программ, которые работают на /usr/bin/lua ==
-# Двоичные (arch) модули собираются стандартно для последней версии. При возникновении необходимости в модуле для более старой версии интерпретатора, отдельный пакет порождается и собирается вручную, см. [[#Правила упаковки модулей для старых версий языка|ниже]]
-# Если модуль/Lua-библиотека хорошо совместима со старой версией Lua и является полностью noarch, то при помощи spec-макроса ''%{lua_modules_make_available_for_older_versions}'' модуль становится мульти-луа-пригодным, т.е. как для 5.3, так и для 5.1. Необходимо также добавить <code>Provides: luarocks5.1(имямод)</code>.
-== Правила упаковки модулей для старых версий языка ==
+Программы, имеющие в shebang <code>#!/usr/bin/lua</code> или <code>#!/usr/bin/env lua</code>, будут запускаться интерпретатором, на который ссылается ''/usr/bin/lua'', т.е. на текущий момент ''lua-5.3''
-Вследствие того, что в сборочную среду невозможно установить одновременно liblua5.3-devel и liblua5.1-devel, сборка двоичных модулей под два интерпретатора пока принципиально невозможна.
+Отсюда следующие рекомендации:
+* (как правило), если у программы есть привязка к версии интерпретатора, то это надо указать в shebang, например, <code>#!/usr/bin/lua5.1</code> или <code>#!/usr/bin/lua5.3</code>
+* если у программы есть зависимость на модули lua, то необходимо их добавить в зависимости, учитывая версию интерпретатора (например, <code>luarocks5.3(luasocket)</code> или <code>luarocks5.1(luasocket)</code>)
-Поэтому при сборке этих модулей '''отдельно''', необходимо соблюдать следующие правила:
+== Архитектуры LuaJIT ==
-# модули должны подчиняться всем правилам модулей Lua, описанным выше, учитывая корректировки, перечисленные ниже
-# Именование модулей: lua%{версия_Lua}-module-имямод, например <code>lua5.1-module-luasocket</code>.
-# в верхней части спека добавить версию Lua: <code>%define lua lua5.1</code>.
-# Пакет должен предоставлять зависимость вида <code>luarocks%{версия_Lua}(имямод)</code>, например <code>luarocks5.1(luasocket)</code>
-# Пакет должен иметь зависимость вида <code>luarocks(luasocket) = %EVR</code>, т.е. зависеть от пакета для [[#Главная версия|Главной версии]] и устанавливать его.
-# <code>BuildPreReq: rpm-macros-lua >= 1.3 lib%lua-devel %lua</code>
-# в %files <code>%exclude %luarocks_dbdir/%oname</code>
-# зависимости от других модулей должны быть исправлены на модули для требуемой версии Lua
-Если внести все эти правки в спек для основной версии модуля, должен получиться собираемый модуль для старой версии интерпретатора. Планируется написание скрипта, делающего это автоматически, который появится в репозитарии lrimport.
-== Правила упаковки программ, которые работают на /usr/bin/lua ==
-Программы, имеющие в shebang <code>#!/usr/bin/lua</code> или <code>#!/usr/bin/env lua</code>, будут '''запускаться интерпретатором''' [[#Главная версия|Главной версии]], т.е. на текущий момент '''5.3'''
+Во избежание поддержки списка <code>ExclusiveArch</code> вручную предлагается применять {{pkg|rpm-macros-luajit}}:
-Поэтому предлагаем следующие рекомендации:
+ BuildRequires(pre): rpm-macros-luajit
-* если у программы есть привязка к версии интерпретатора, то это надо указать в shebang, например, <code>#!/usr/bin/lua5.1</code> или <code>#!/usr/bin/lua5.3</code>
-* если у программы есть зависимость на модули lua, то необходимо их добавить в зависимости, учитывая версию интерпретатора (например, <code>luarocks(luasocket)</code> или <code>luarocks5.1(luasocket)</code>)
+ ExclusiveArch: %luajit_arches
-* если у программы есть зависимость на модули lua не-[[#Главная версия|Главной версии]], например, <code>luarocks5.1(luasocket)</code>, то надо указать привязку к версии в shebang, например, <code>#!/usr/bin/lua5.1</code>
 == Нерешенные проблемы ==
 # [http://git.altlinux.org/people/ildar/public/?p=lrimport.git lrimport] не является полностью автоматизированным средством. Патчи приветствуются.
-# Вследствие того, что в сборочную среду невозможно установить одновременно liblua5.3-devel и liblua5.1-devel, сборка двоичных модулей под два интерпретатора пока невозможна
+# Вследствие того, что в сборочную среду невозможно установить одновременно liblua5.3-devel и liblua5.1-devel, сборка двоичных модулей из одного SRPM под два интерпретатора пока невозможна
 == Ссылки ==