Рекомендации по упаковке Haskell

На этой странице описаны рекомендации и соглашения по упаковке проектов на Haskell в Fedora.

GHC (Glasgow Haskell Compiler) — это текущий основной компилятор Haskell. Большинство пакетов Haskell выпускаются на Hackage и используют систему пакетов Cabal. Поэтому текущие рекомендации в основном сосредоточены на упаковке для GHC с использованием Cabal.

Шаблоны spec-файлов

Spec-файлы, соответствующие этим шаблонам, автоматически создаются инструментом упаковки cabal-rpm, который также добавляет зависимости, перечисленные в конфигурационном файле пакета .cabal. После этого большинство пакетов должно собираться, хотя для некоторых пакетов может потребоваться указать дополнительные BuildRequires и/или Requires и проверить зависимости devel, не связанные с Haskell.

Стандартизация упаковки помогает снизить нагрузку по сопровождению пакетов Haskell в Fedora.

Существует три типа пакетов Haskell Cabal: библиотека (Lib), только бинарный (Bin) и бинарный с библиотекой (BinLib):

Только библиотека

%global pkg_name @PACKAGE@

Name:           ghc-%{pkg_name}
Version:        @VERSION@
Release:        1%{?dist}
Summary:        @SUMMARY@

License:        @LICENSE@
URL:            https://hackage.haskell.org/package/%{pkg_name}
Source:         https://hackage.haskell.org/package/%{pkg_name}-%{version}/%{pkg_name}-%{version}.tar.gz

BuildRequires:  ghc-Cabal-devel
BuildRequires:  ghc-rpm-macros
BuildRequires:  ghc-base-prof

%description
@DESCRIPTION@

%package devel
Summary:        Haskell %{pkg_name} library development files
Provides:       %{name}-static = %{version}-%{release}
Provides:       %{name}-static%{?_isa} = %{version}-%{release}
Requires:       ghc-compiler = %{ghc_version}
Requires:       %{name}%{?_isa} = %{version}-%{release}

%description devel
This package provides the Haskell %{pkg_name} library development files.


%package doc
Summary:        Haskell %{pkg_name} library documentation
BuildArch:      noarch

%description doc
This package provides the Haskell %{pkg_name} library documentation.


%package prof
Summary:        Haskell %{pkg_name} profiling library
Requires:       %{name}-devel%{?_isa} = %{version}-%{release}
Supplements:    (%{name}-devel and ghc-prof)

%description prof
This package provides the Haskell %{pkg_name} profiling library.


%prep
%setup -q -n %{pkg_name}-%{version}


%build
%ghc_lib_build


%install
%ghc_lib_install


%files -f %{name}.files
%license LICENSE


%files devel -f %{name}-devel.files


%files doc -f %{name}-doc.files
%license LICENSE


%files prof -f %{name}-prof.files

Только бинарный

Name:           @PACKAGE@
Version:        @VERSION@
Release:        1%{?dist}
Summary:        @SUMMARY@

License:        @LICENSE@
URL:            https://hackage.haskell.org/package/%{name}
Source:         https://hackage.haskell.org/package/%{name}-%{version}/%{name}-%{version}.tar.gz

BuildRequires:  ghc-Cabal-devel
BuildRequires:  ghc-rpm-macros
BuildRequires:  ghc-base-static

%description
@DESCRIPTION@


%prep
%setup -q


%build
%ghc_bin_build


%install
%ghc_bin_install


%files
%license LICENSE
%{_bindir}/%{name}

BinLib

%global pkg_name @PACKAGE@

Name:           %{pkg_name}
Version:        @VERSION@
Release:        1%{?dist}
Summary:        @SUMMARY@

License:        @LICENSE@
URL:            https://hackage.haskell.org/package/%{name}
Source:         https://hackage.haskell.org/package/%{name}-%{version}/%{name}-%{version}.tar.gz

BuildRequires:  ghc-Cabal-devel
BuildRequires:  ghc-rpm-macros
BuildRequires:  ghc-base-prof

%description
@DESCRIPTION@


%package -n ghc-%{name}
Summary:        Haskell %{name} library

%description -n ghc-%{name}
This package contains the Haskell %{name} library.


%package -n ghc-%{name}-devel
Summary:        Haskell %{name} library development files
Requires:       ghc-compiler = %{ghc_version}
Requires:       ghc-%{name} = %{version}-%{release}

%description -n ghc-%{name}-devel
This package provides the Haskell %{pkg_name} library development files.


%package -n ghc-%{name}-doc
Summary:        Haskell %{pkg_name} library documentation
BuildArch:      noarch

%description -n ghc-%{name}-doc
This package provides the Haskell %{pkg_name} library documentation.


%package -n ghc-%{name}-prof
Summary:        Haskell %{pkg_name} profiling library
Requires:       ghc-%{name}-devel%{?_isa} = %{version}-%{release}
Supplements:    (ghc-%{name}-devel and ghc-prof)

%description -n ghc-%{name}-prof
This package provides the Haskell %{pkg_name} profiling library.


%prep
%setup -q


%build
%ghc_lib_build


%install
%ghc_lib_install


%files
%license LICENSE
%{_bindir}/%{name}


%files -n ghc-%{name} -f ghc-%{name}.files
%license LICENSE


%files -n ghc-%{name}-devel -f ghc-%{name}-devel.files


%files -n ghc-%{name}-doc -f ghc-%{name}-doc.files
%license LICENSE


%files -n ghc-%{name}-prof -f ghc-%{name}-prof.files

Именование пакетов

Пакеты Haskell Bin должны следовать обычным рекомендациям Fedora по именованию базовых пакетов: то есть следовать имени апстрима. Примеры включают такие проекты, как alex и cabal-install.

Имена пакетов Haskell Lib, упакованных для ghc, имеют префикс «ghc-». Например, пакет библиотеки Haskell aeson называется ghc-aeson, а пакет библиотеки Haskell X11 называется ghc-X11 и т. д.

Пакеты Haskell BinLib должны называться как пакет Bin, если наиболее важная их часть — исполняемый файл (например, hlint, ShellCheck и pandoc), в противном случае они должны называться и упаковываться как пакет Lib (например, ghc-hakyll (имеет установочный исполняемый файл), ghc-vty (имеет демонстрационные исполняемые файлы)), если на самом деле это библиотека, включающая вспомогательный исполняемый файл, демонстрацию или второстепенную утилиту. В этом случае обычно исполняемый файл должен находиться в подпакете devel (или, возможно, в базовом пакете библиотеки, если он используется во время выполнения).

Обратите внимание, что наличие разных исходных пакетов Haskell с именами «ghc-xyz» и «xyz» не допускается, поскольку оба они будут соответствовать одному и тому же пакету апстрима с именем «xyz» на Hackage.

Пакеты BinLib должны выделять свои библиотеки в подпакеты, следуя именованию пакетов Lib. Например, пакет pandoc BinLib имеет подпакеты библиотеки

  • ghc-pandoc для разделяемой библиотеки,

  • ghc-pandoc-devel для devel-файлов и статической библиотеки,

  • ghc-pandoc-prof для статической библиотеки профилирования,

  • ghc-pandoc-doc для извлечённой документации по разработке библиотеки.

Если библиотека упаковывается для более чем одного компилятора или интерпретатора Haskell, базовое имя вместо этого должно иметь префикс haskell, например haskell-X11. Такой пакет затем имел бы подпакеты для каждого компилятора и/или интерпретатора, для которого он собран (например, ghc-X11, hugs98-X11` и т. д.).

Именование пакетов сохраняет регистр, чтобы как можно точнее следовать соглашениям об именовании апстрима, включая зависимости пакетов.

Заголовки

Макрос pkg_name используется для хранения имени пакета библиотеки апстрима (то есть без префикса Fedora «ghc-»). Его следует определять в начале пакетов Lib и BinLib:

%global pkg_name

Флаги Cabal

При необходимости флаги Cabal для параметров сборки следует задавать, изменяя файл .cabal пакета: обычно это можно сделать с помощью скрипта cabal-tweak-flag, чтобы избежать необходимости нести и поддерживать патчи для этого.

Например, cabal-tweak-flag systemlib True может включить флаг для использования системной библиотечной зависимости.

%cabal_configure_options можно задать для передачи других параметров в Cabal.

Изменение значений по умолчанию флагов в файле .cabal позволяет упаковщикам и таким инструментам, как cabal-rpm, корректно отслеживать фактические зависимости пакета.

Зависимости

Скрипт cabal-tweak-dep-ver можно использовать для изменения границ версий зависимостей в файле .cabal пакета: cabal-tweak-dep-ver deppkg oldbound newbound

например: cabal-tweak-dep-ver base '< 4.16' '< 4.17'

Аналогично cabal-tweak-drop-dep для удаления избыточной зависимости (например, фиктивного пакета совместимости).

например: cabal-tweak-drop-dep mtl-compat

Зависимости сборки spec-файла генерируются инструментом упаковки cabal-rpm.

Бинарные зависимости RPM для библиотек Haskell автоматически генерируются во время сборки скриптом ghc-deps.sh.

Линковка разделяемых и статических библиотек

GHC по умолчанию использует статические библиотеки для линковки. Пакеты Lib и BinLib должны предоставлять статические, разделяемые и профилирующие библиотеки:

  • разделяемая библиотека находится в базовом пакете библиотеки,

  • статическая библиотека и файлы интерфейса разработки в подпакете -devel,

  • а библиотека профилирования и файлы интерфейса профилирования в подпакете -prof.

Поскольку GHC предполагает, что установлены статические версии библиотек, они должны находиться в подпакете devel, и выделять их в отдельный подпакет не имеет смысла.

Исполняемые файлы в пакетах Bin и BinLib должны быть статически слинкованы для переносимости.

Из-за того, как GHC линкует разделяемые библиотеки с помощью --no-as-needed, они генерируют множество ошибок rpmlint E: undefined-non-weak-symbol; к сожалению, в настоящее время это ожидаемо (см. эти проблемы апстрима).

RPM-макросы

Все шаблоны имеют buildrequires для ghc-rpm-macros, который предоставляет macros.ghc для помощи в упаковке пакетов Haskell Cabal.

BuildRequires:  ghc-rpm-macros

Основные часто используемые макросы:

  • %ghc_bin_build

  • %ghc_lib_build

  • %ghc_bin_install

  • %ghc_lib_install

Они используются в шаблонах и более подробно описаны ниже.

Пакеты Bin

Исполняемые файлы по умолчанию статически слинкованы с библиотеками Haskell.

%build
%ghc_bin_build


%install
%ghc_bin_install

%ghc_bin_build используется для настройки и сборки пакетов bin. Он выполняет:

  • %cabal_configure: настраивает пакет для сборки и динамической линковки.

  • %cabal build: собирает пакет.

%ghc_bin_install используется для установки пакетов bin. Он выполняет:

  • %cabal_install: для установки пакета.

Пакеты Lib и BinLib

Подпакетам devel нужно настроить некоторые Requires:

%package -n ghc-%{pkg_name}-devel
Summary:        Haskell %{pkg_name} library development files
Requires:       ghc-compiler = %{ghc_version}
Requires:       ghc-%{pkg_name} = %{version}-%{release}

Пакетам Lib нужно использовать %setup -n:

%prep
%setup -q -n %{pkg_name}-%{version}

И Lib, и BinLib имеют:

%build
%ghc_lib_build


%install
%ghc_lib_install

%ghc_lib_build используется для настройки, сборки и генерации документации для пакетов Lib и BinLib. Он выполняет:

  • %cabal_configure --ghc -p: настраивает пакет для сборки с ghc и профилированием. Библиотеки должны собирать версии профилирования своих статических библиотек.

  • %cabal build: собирает пакет.

  • %cabal haddock: генерирует HTML-документацию библиотеки из исходного кода.

    • Если документация по какой-то причине не собирается, %ghc_lib_build_without_haddock можно использовать вместо %ghc_lib_build, чтобы отключить генерацию haddock.

%ghc_lib_install используется для установки пакетов Lib и BinLib. Он выполняет:

  • %cabal_install: устанавливает пакет без регистрации его в ghc-pkg.

  • %cabal_pkg_conf: создаёт метаданные .conf для ghc-pkg на момент установки пакета

  • %ghc_gen_filelists: генерирует списки файлов rpm.

Отладочная информация

Отладочная информация в настоящее время отключена для пакетов Haskell, поскольку вывод Dwarf от ghc не очень полезен. Трассировки стека также могут быть сгенерированы с использованием библиотек профилирования.

Каталоги

Библиотеки GHC устанавливаются в %ghclibdir/%{pkg_name}-%{version}:

Документация библиотеки находится в %ghclibdocdir/%{pkg_name}-%{version}.

Списки файлов

Списки файлов для подпакетов разделяемой библиотеки и библиотеки devel генерируются с помощью %ghc_lib_install с использованием макроса %ghc_gen_filelists.

Он генерирует списки файлов ghc-%{pkg_name}.files, ghc-%{pkg_name}-devel.files, ghc-%{pkg_name}-prof.files и ghc-%{pkg_name}-doc.files.

Компиляция пакетов, не использующих Cabal

Пакеты, компилирующие код Haskell без Cabal, то есть напрямую с помощью ghc или ghc --make, должны использовать оптимизацию -O1, как это делает Cabal по умолчанию.