コンテンツにスキップ

「Haskell パッケージガイドライン」の版間の差分

提供: ArchWiki
削除された内容 追加された内容
ページの作成:「Category:パッケージ開発 en:Haskell package guidelines it:Haskell package guidelines {{Package Guidelines}} このドキュメントでは Arch で良...」
 
Kgx (トーク | 投稿記録)
他言語へのリンクを追加
 
(2人の利用者による、間の9版が非表示)
1行目: 1行目:
[[Category:パッケージ開発]]
[[Category:パッケージ開発]]
[[en:Haskell package guidelines]]
[[en:Haskell package guidelines]]
[[it:Haskell package guidelines]]
[[pt:Haskell package guidelines]]
[[zh-hans:Haskell package guidelines]]
{{Package Guidelines}}
{{Package Guidelines}}


このドキュメントは Arch で良質な [[Haskell]] [[パッケージの作成|パッケージ]]を作成するための決まり事とガイドラインを説明しています。
このドキュメントは Arch で良 [[Haskell]] [[パッケージの作成|packages]] を作るための標準やガイドラインを網羅することを目的としています。


== パッケージの命名 ==
== cabal2pkgbuild ==


Haskell ライブラリには {{ic|haskell-''libraryname''}} を使用し、通常は [https://hackage.haskell.org/ hackage] と同じ名前を使用します。
[[AUR]] の {{AUR|cabal2pkgbuild-git}} を使うことで [[Haskell#cabal-install|cabal]] ビルドファイルから Arch パッケージを自動的に作成することができます。cabal2pkgbuild は [https://github.com/magthe/cblrepo cblrepo] のラッパーです。基本的に、一つのパッケージ ([[PKGBUILD]]) に一つの {{ic|.cabal}} ファイルが存在するようにしてください。

{{Note|パッケージ名はすべて小文字にする必要があります}}

== アーキテクチャ ==

[[PKGBUILD#arch]] を参照してください。

すべての Haskell ライブラリまたはプログラムはアーキテクチャに依存します。

== ソース ==

Haskell のプログラムやライブラリのソースは、[https://hackage.haskell.org hackage] が好ましいです。[[PKGBUILD#source]] にあります。{{ic|1=source=()}} 配列は、以下の URL テンプレートを使用してください。

<nowiki>https://hackage.haskell.org/packages/archive/$_hkgname/$pkgver/$_hkgname-$pkgver.tar.gz</nowiki>

Haskell のパッケージは一般的に ''haskell-'' という接頭辞が付くため、{{ic|hkgname}} の代わりにカスタム変数 {{ic|_hkgname}} が使用されることに注意してください。この変数は一般的に以下のように定義することができます。

_hkgname=stm-delay

== リビルドの順番 ==

Haskell ライブラリがビルドフラグを変更したり更新された場合、依存するパッケージはすべてリビルドする必要があります。[https://github.com/felixonmars/archlinux-futils/blob/master/genrebuild genrebuild] ツールは、何がどのようにリビルドされる必要があるかを調べるために使用できます。使用例です。

$ ./genrebuild -H haskell-basement

== arch-hs の使用方法 ==

{{Pkg|arch-hs}} は {{ic|PKGBUILD}} の生成と保守を自動化するために提供されています。

Hackage パッケージ(とパッケージ化されていない依存パッケージ)に対して一連の {{ic|PKGBUILD}} を生成するには。

$ arch-hs -o /path/to/workdir library_name

既存のパッケージを更新するために、依存関係やその他のパッケージング・メタデータを比較する。

$ arch-hs-diff library_name old_version new_version

Arch [community] パッケージのバージョンと、それに対応する Hackage パッケージのバージョンを比較する。

$ arch-hs-sync check

なお、{{ic|arch-hs}} は Hackage データベースの保守に {{Pkg|cabal-install}} を使用していますので、定期的に ''cabal-install'' データベースを更新し維持して下さい。

$ cabal update

== PKGBUILD ライブラリの例 ==

Haskell ライブラリのパッケージ化は Haskell プログラムのパッケージ化とは異なります。ArchLinux にパッケージ化されたライブラリは、パッケージ化された Haskell プログラムで使用されることを目的としています。

{{hc|PKGBUILD|<nowiki>
# Maintainer: Your Name <youremail@domain.com>
_hkgname=stm-delay
pkgname=haskell-stm-delay
pkgver=
pkgrel=1
license=()
arch=('x86_64')
url="https://hackage.haskell.org/package/$_hkgname"
depends=(ghc-libs)
makedepends=(ghc)
source=("https://hackage.haskell.org/packages/archive/$_hkgname/$pkgver/$_hkgname-$pkgver.tar.gz")
sha256sums=()

build() {
cd "$_hkgname-$pkgver"

runhaskell Setup configure -O --enable-shared --enable-executable-dynamic --disable-library-vanilla \
--prefix=/usr --docdir="/usr/share/doc/$pkgname" --enable-tests \
--dynlibdir=/usr/lib --libsubdir=\$compiler/site-local/\$pkgid \
--ghc-option=-optl-Wl\,-z\,relro\,-z\,now \
--ghc-option='-pie'

runhaskell Setup build $MAKEFLAGS
runhaskell Setup register --gen-script
runhaskell Setup unregister --gen-script
sed -i -r -e "s|ghc-pkg.*update[^ ]* |&'--force' |" register.sh
sed -i -r -e "s|ghc-pkg.*unregister[^ ]* |&'--force' |" unregister.sh
}

check() {
cd "$_hkgname-$pkgver"
runhaskell Setup test
}

package() {
cd "$_hkgname-$pkgver"

install -D -m744 register.sh "$pkgdir/usr/share/haskell/register/$pkgname.sh"
install -D -m744 unregister.sh "$pkgdir/usr/share/haskell/unregister/$pkgname.sh"
runhaskell Setup copy --destdir="$pkgdir"
install -D -m644 "LICENSE" "${pkgdir}/usr/share/licenses/${pkgname}/LICENSE"
rm -f "${pkgdir}/usr/share/doc/${pkgname}/LICENSE"
}
</nowiki>}}

2023年6月29日 (木) 21:43時点における最新版

このドキュメントは Arch で良い Haskell packages を作るための標準やガイドラインを網羅することを目的としています。

パッケージの命名

Haskell ライブラリには haskell-libraryname を使用し、通常は hackage と同じ名前を使用します。

ノート パッケージ名はすべて小文字にする必要があります

アーキテクチャ

PKGBUILD#arch を参照してください。

すべての Haskell ライブラリまたはプログラムはアーキテクチャに依存します。

ソース

Haskell のプログラムやライブラリのソースは、hackage が好ましいです。PKGBUILD#source にあります。source=() 配列は、以下の URL テンプレートを使用してください。

https://hackage.haskell.org/packages/archive/$_hkgname/$pkgver/$_hkgname-$pkgver.tar.gz

Haskell のパッケージは一般的に haskell- という接頭辞が付くため、hkgname の代わりにカスタム変数 _hkgname が使用されることに注意してください。この変数は一般的に以下のように定義することができます。

_hkgname=stm-delay

リビルドの順番

Haskell ライブラリがビルドフラグを変更したり更新された場合、依存するパッケージはすべてリビルドする必要があります。genrebuild ツールは、何がどのようにリビルドされる必要があるかを調べるために使用できます。使用例です。

$ ./genrebuild -H haskell-basement

arch-hs の使用方法

arch-hsPKGBUILD の生成と保守を自動化するために提供されています。

Hackage パッケージ(とパッケージ化されていない依存パッケージ)に対して一連の PKGBUILD を生成するには。

$ arch-hs -o /path/to/workdir library_name

既存のパッケージを更新するために、依存関係やその他のパッケージング・メタデータを比較する。

$ arch-hs-diff library_name old_version new_version

Arch [community] パッケージのバージョンと、それに対応する Hackage パッケージのバージョンを比較する。

$ arch-hs-sync check

なお、arch-hs は Hackage データベースの保守に cabal-install を使用していますので、定期的に cabal-install データベースを更新し維持して下さい。

$ cabal update

PKGBUILD ライブラリの例

Haskell ライブラリのパッケージ化は Haskell プログラムのパッケージ化とは異なります。ArchLinux にパッケージ化されたライブラリは、パッケージ化された Haskell プログラムで使用されることを目的としています。

PKGBUILD
# Maintainer: Your Name <youremail@domain.com>
_hkgname=stm-delay
pkgname=haskell-stm-delay
pkgver=
pkgrel=1
license=()
arch=('x86_64')
url="https://hackage.haskell.org/package/$_hkgname"
depends=(ghc-libs)
makedepends=(ghc)
source=("https://hackage.haskell.org/packages/archive/$_hkgname/$pkgver/$_hkgname-$pkgver.tar.gz")
sha256sums=()

build() {
  cd "$_hkgname-$pkgver"

  runhaskell Setup configure -O --enable-shared --enable-executable-dynamic --disable-library-vanilla \
    --prefix=/usr --docdir="/usr/share/doc/$pkgname" --enable-tests \
    --dynlibdir=/usr/lib --libsubdir=\$compiler/site-local/\$pkgid \
    --ghc-option=-optl-Wl\,-z\,relro\,-z\,now \
    --ghc-option='-pie'

  runhaskell Setup build $MAKEFLAGS
  runhaskell Setup register --gen-script
  runhaskell Setup unregister --gen-script
  sed -i -r -e "s|ghc-pkg.*update[^ ]* |&'--force' |" register.sh
  sed -i -r -e "s|ghc-pkg.*unregister[^ ]* |&'--force' |" unregister.sh
}

check() {
  cd "$_hkgname-$pkgver"
  runhaskell Setup test
}

package() {
  cd "$_hkgname-$pkgver"

  install -D -m744 register.sh "$pkgdir/usr/share/haskell/register/$pkgname.sh"
  install -D -m744 unregister.sh "$pkgdir/usr/share/haskell/unregister/$pkgname.sh"
  runhaskell Setup copy --destdir="$pkgdir"
  install -D -m644 "LICENSE" "${pkgdir}/usr/share/licenses/${pkgname}/LICENSE"
  rm -f "${pkgdir}/usr/share/doc/${pkgname}/LICENSE"
}