Go パッケージガイドライン - 版の履歴

Kgx: /* デバッグパッケージのサポート */ 翻訳を修正

2023-06-29T18:54:42Z

デバッグパッケージのサポート: 翻訳を修正

← 古い版		2023年6月30日 (金) 03:54時点における版
79行目:		79行目:
	* {{ic\|1=GOPATH="${srcdir}"}} を含めると、''makepkg'' にすべてのモジュールのソースコードを含めることができます。		* {{ic\|1=GOPATH="${srcdir}"}} を含めると、''makepkg'' にすべてのモジュールのソースコードを含めることができます。

	上記のオプションは~~、デバッガーが選択できる~~、適切に分離されたシンボルとソースリストを含むデバッグパッケージを生成~~する必要~~があります。		上記のオプションは、適切に分離されたシンボルとソースリストを持つデバッグパッケージを生成し、デバッガがそれをピックアップできるようにします。

	{{bc\|1=		{{bc\|1=

Kgx: 無駄な改行を削除

2023-06-29T18:51:48Z

無駄な改行を削除

← 古い版		2023年6月30日 (金) 03:51時点における版
13行目:		13行目:

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


	== ビルド ==		== ビルド ==

Kgx: 他言語へのリンクを追加

2023-06-26T13:02:20Z

他言語へのリンクを追加

← 古い版		2023年6月26日 (月) 22:02時点における版
1行目:		1行目:
	[[Category:パッケージ開発]]		[[Category:パッケージ開発]]
	[[en:Go package guidelines]]		[[en:Go package guidelines]]
			[[pt:Go package guidelines]]
			[[zh-hans:Go package guidelines]]
	{{Package Guidelines}}		{{Package Guidelines}}
	このドキュメントでは、[[Go]] の [[PKGBUILD]] の作成に関する標準とガイドラインについて説明します。		このドキュメントでは、[[Go]] の [[PKGBUILD]] の作成に関する標準とガイドラインについて説明します。

Kgx: /* Example packages */ 翻訳

2023-06-26T13:01:29Z

Example packages: 翻訳

← 古い版		2023年6月26日 (月) 22:01時点における版
156行目:		156行目:
	</nowiki>}}		</nowiki>}}

	== ~~Example packages~~ ==		== パッケージ例 ==

	* {{Pkg\|podman}}		* {{Pkg\|podman}}

Kgx: /* Sample PKGBUILD */ 翻訳

2023-06-26T13:01:08Z

Sample PKGBUILD: 翻訳

← 古い版		2023年6月26日 (月) 22:01時点における版
116行目:		116行目:
	}}		}}

	== ~~Sample~~ PKGBUILD ==		== サンプル PKGBUILD ==

	{{bc\|<nowiki>		{{bc\|<nowiki>

Kgx: /* Output directory */ 翻訳

2023-06-26T13:00:39Z

Output directory: 翻訳

← 古い版		2023年6月26日 (月) 22:00時点における版
91行目:		91行目:
	}}		}}

	=== ~~Output directory~~ ===		=== 出力ディレクトリ ===

			現在、プロジェクト内のすべての Go バイナリをビルドする方法はいくつかあります。
	There are currently a few ways to build all go binaries in a project.

	{{bc\|		{{bc\|
102行目:		102行目:
	}}		}}

			{{ic\|...}} は、コンパイラがディレクトリに再帰的に降りてすべてのバイナリを検索するための省略表現です。出力ディレクトリと組み合わせて使用し、すべてをビルドできます。
	{{ic\|...}} is a shorthand for the compiler to recursively descend into the directory and find all binaries. It can be used in conjunction with a output directory to build everything.

	{{bc\|		{{bc\|

Kgx: /* Supporting debug packages */ 翻訳

2023-06-26T12:59:33Z

Supporting debug packages: 翻訳

← 古い版		2023年6月26日 (月) 21:59時点における版
69行目:		69行目:
	{{Warning\|ビルドフラグがコンパイラに正しく渡されたことを確認するのはパッケージャーの責任です。{{ic\|Makefile}} がある場合はそれを読みます。}}		{{Warning\|ビルドフラグがコンパイラに正しく渡されたことを確認するのはパッケージャーの責任です。{{ic\|Makefile}} がある場合はそれを読みます。}}

			==== デバッグパッケージのサポート ====
	==== Supporting debug packages ====

			ソースリストと適切なシンボルルックアップを使用してデバッグパッケージを有効にするには、デフォルトのビルドフラグをいくつか変更する必要があります。
	Enabling debug packages with source listing and proper symbol look ups require a few modifications to the default buildflags.

			* ソースパスがバイナリで確実に書き換えられるようにするため、{{ic\|-trimpath}} を削除
	* Removal of {{ic\|-trimpath}} to ensure source paths are rewritten in the binary
			* 現在のツールは圧縮ヘッダーをサポートしていないため、DWARF ヘッダーを確実に解析できるように、{{ic\|1=-compressdwarf=false}} を {{ic\|-ldflags}} に含めます。
	* Include {{ic\|1=-compressdwarf=false}} in {{ic\|-ldflags}} to ensure we can parse the DWARF headers as current tooling does not support compressed headers.
			* Go が使用する内部リンカーとして {{ic\|1=-linkmode=external}} がバイナリにビルド ID を埋め込まないようにしてください。
	* Ensure {{ic\|1=-linkmode=external}} as the internal linker go uses does not embed a build-id into the binary.
	* ~~Include~~ {{ic\|1=GOPATH="${srcdir}"}} so ''makepkg'' ~~can include the source code for all modules.~~		* {{ic\|1=GOPATH="${srcdir}"}} を含めると、''makepkg'' にすべてのモジュールのソースコードを含めることができます。

			上記のオプションは、デバッガーが選択できる、適切に分離されたシンボルとソースリストを含むデバッグパッケージを生成する必要があります。
	The above options should produce a debug package with proper detached symbols and source listings which can then be picked up by the debugger.

	{{bc\|1=		{{bc\|1=

Kgx: /* Flag meaning */ 翻訳

2023-06-26T12:57:31Z

Flag meaning: 翻訳

← 古い版		2023年6月26日 (月) 21:57時点における版
58行目:		58行目:
	}}		}}

	==== ~~Flag meaning~~ ====		==== フラグの意味 ====

	* {{ic\|1=-buildmode=pie}} ~~enables~~ [[Wikipedia:~~Position-independent code~~\|PIE ~~compilation~~]] ~~for binary harderning.~~		* {{ic\|1=-buildmode=pie}} バイナリ強化のために [[Wikipedia:ja:位置独立コード\|PIE コンパイル]] を有効にします。
			* {{ic\|-trimpath}} [[再現性のあるビルド]] にとって重要であるため、完全なビルドパスとモジュールパスは埋め込まれません。
	* {{ic\|-trimpath}} important for [[reproducible builds]] so full build paths and module paths are not embedded.
			* {{ic\|1=-mod=readonly}} どの go アクションでもモジュールファイルが更新されていないことを確認してください。
	* {{ic\|1=-mod=readonly}} ensure the module files are not updated in any go actions.
			* {{ic\|-modcacherw}} は重要ではありませんが、これにより go モジュールが書き込み可能なパスを作成することが保証されます。デフォルトは読み取り専用です。
	* {{ic\|-modcacherw}} is not important, but it ensures that go modules creates a write-able path. Default is read-only.

	{{Tip\|~~When package sources include a~~ {{ic\|~~vendor~~}} ~~directory with~~ {{ic\|~~modules.txt~~}}~~, the~~ {{ic\|-mod}} ~~flag can safely be changed to~~ {{ic\|1=-mod=vendor}}.}}		{{Tip\|パッケージソースに {{ic\|modules.txt}} を含む {{ic\|vendor}} ディレクトリが含まれている場合、{{ic\|-mod}} フラグを次のように安全に変更できます。{{ic\|1=-mod=vendor}}.}}

			{{Warning\|ビルドフラグがコンパイラに正しく渡されたことを確認するのはパッケージャーの責任です。{{ic\|Makefile}} がある場合はそれを読みます。}}
	{{Warning\|It is up to the packager to verify the build flags are passed correctly to the compiler. Read the {{ic\|Makefile}} if there is one.}}

	==== Supporting debug packages ====		==== Supporting debug packages ====

Kgx: 情報を更新

2023-06-26T12:53:54Z

情報を更新

差分を表示

Kusakata: 翻訳

2016-11-07T14:22:46Z

翻訳

新規ページ

[[Category:パッケージ開発]]
[[en:Go package guidelines]]
{{Package Guidelines}}

[[Wikipedia:ja:Go (プログラミング言語)|Go]] は Arch Linux で十分にサポートされています。

{{Pkg|go}} パッケージには ({{Ic|go fix}}, {{Ic|go build}} などを実行するための) '''go''' ツールが含まれています。また {{Pkg|gcc-go}} は {{Ic|gccgo}} を提供します。

[https://github.com/seletskiy/go-makepkg go-makepkg] ツールを使うことで手動で PKGBUILD ファイルを作成しなくても簡単に Go のプログラムをパッケージ化できます。

== 一般的なガイドライン ==

=== 命名 ===
* Go で書かれたアプリケーションの場合、パッケージ名はアプリケーションの名前にしてください (小文字)。
** パッケージ名が既に使われている場合は何か別の名前を考案してください。
* Go で書かれたライブラリの場合、{{Ic|go-''modulename''}} という名前にしてください (小文字)。
** ライブラリの名前に {{Ic|go-}} と付いている場合は、パッケージ名を {{Ic|go-''go-modulename''}} とせず {{Ic|go-''modulename''}} としてください。
* パッケージをダウンロードするのに "go" ツールを使用する PKGBUILD の場合、tarball やタグ付きリリースからビルドされない場合にのみパッケージ名に "-git" を追加してください (trunk/HEAD からビルドされる場合)。
** mercurial のパッケージの場合でも、同じようにリリース版でないときにパッケージ名に "-hg" と追加してください。
** 他のバージョン管理システムでも同じようにしてください。
** どのブランチやタグを使用するべきか決めるときに go ツールには独自のロジックがあります。{{Ic|go get --help}} を見てください。
* 同じ名前のアプリケーションが複数ある場合はパッケージ名に開発者の名前を追加すると良いでしょう。例: {{AUR|dcpu16-kballard}}。
** 一般的には、最も人気のあるパッケージが一番短くてわかりやすい名前を使用するべきです。
* プロジェクトの公式リリースが存在しない場合にパッケージ名に ({{Ic|-hg}}, {{Ic|-git}}, {{Ic|-svn}} などの) 文字列を付け加えるかは任意です。VCS からパッケージがダウンロードされる場合は付けるのが普通ですが、Go のプロジェクトの多くにはリリース tarball が存在せず、''trunk'' でない場合に公式リリースとしてブランチやタグが付けられるリポジトリしかありません。また、''Go'' のモジュールをインストールするときに使用する「公式」の手段である {{Ic|go get}} はリポジトリを直接使用します。

=== パッケージ ===
* Go プロジェクトはライブラリファイルか実行ファイル、あるいはその両方です。適切な方法でパッケージ化してください。以下では複数の例を示します。
* Go アプリケーションやライブラリの中には最新バージョンの Go にあわせて更新されていないものがあります。
** {{Ic|go build -fix}} で大抵は動作しますが、修正は開発者が行うべきです。問題がある場合は上流に報告してください。
* Go プロジェクトの中にはバージョン番号やライセンスファイルを持たないものがあります。
** ライセンスファイルが存在しない場合は license=('unknown') を使用して開発者に問題を報告してください。
** バージョン番号が存在しない場合は "0.1", "1" あるいは git のリビジョン (あるいは他のバージョン管理システムの同等のバージョン) を使用してください。
** もしくは、バージョン番号として日付を使ってください。形式: {{Ic|YYYYMMDD}}。
* Go アプリケーションは基本的に静的コンパイルされるため、Go ライブラリをパッケージ化する理由はあまり多くありません。

== サンプル PKGBUILD ==

=== Go で書かれたアプリケーションのサンプル PKGBUILD ===

{{bc|<nowiki># Maintainer: NAME <EMAIL>

pkgname=PACKAGE NAME
pkgver=1.2.3
pkgrel=1
pkgdesc="PACKAGE DESCRIPTION"
arch=('x86_64' 'i686')
url="http://SERVER/$pkgname/"
license=('MIT')
makedepends=('go')
options=('!strip' '!emptydirs')
source=("http://SERVER/$pkgname/$pkgname-$pkgver.tar.gz")
sha256sums=('00112233445566778899aabbccddeeff')

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

go build
}

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

install -Dm755 "$pkgname-$pkgver" "$pkgdir/usr/bin/$pkgname"
install -Dm644 LICENSE "$pkgdir/usr/share/licenses/$pkgname/LICENSE"
}

# vim:set ts=2 sw=2 et:</nowiki>}}

==== サンプルパッケージ ====
* {{Pkg|gendesk}}
* {{AUR|dcpu16}}

=== ソースファイルがひとつしかない場合のサンプル PKGBUILD ===

{{bc|<nowiki># Maintainer: NAME <EMAIL>

pkgname=PACKAGE NAME
pkgver=1.2.3
pkgrel=1
pkgdesc="PACKAGE DESCRIPTION"
arch=('x86_64' 'i686')
url="http://SERVER/$pkgname/"
license=('GPL3')
makedepends=('go')
options=('!strip' '!emptydirs')
source=("http://SERVER/$pkgname/$pkgname.go")
sha256sums=('00112233445566778899aabbccddeeff')

build() {
go build -o "$pkgname"
}

package() {
install -Dm755 "$pkgname" "$pkgdir/usr/bin/$pkgname"
}

# vim:set ts=2 sw=2 et:</nowiki>}}

==== サンプルパッケージ ====
* {{AUR|gorun}}

=== 実行ファイルも含む Go ライブラリのサンプル PKGBUILD ===

==== ''go get'' を使う (推奨) ====

以下は go get を使用する方法です。

build() や package() 関数を修正する必要は全くありません。変数だけを修正してください (pkgname など)。

以下の方法が使えない場合、まずは go get をテストしてみてください。

{{Note|PKGBUILD でパッケージの作成が失敗する場合は {{Ic|/...}} を削除してください。}}

{{bc|<nowiki># Maintainer: NAME <EMAIL>

pkgname=codesearch
pkgver=20120515
pkgrel=1
pkgdesc="Code indexing and search written in Go"
arch=('x86_64' 'i686')
url="https://github.com/google/codesearch"
license=('BSD')
depends=('go')
makedepends=('mercurial')
options=('!strip' '!emptydirs')
_gourl=github.com/google/codesearch

build() {
GOPATH="$srcdir" go get -fix -v -x ${_gourl}/...
}

check() {
GOPATH="$GOPATH:$srcdir" go test -v -x ${_gourl}/...
}

package() {
mkdir -p "$pkgdir/usr/bin"
install -p -m755 "$srcdir/bin/"* "$pkgdir/usr/bin"

mkdir -p "$pkgdir/$GOPATH"
cp -Rv --preserve=timestamps "$srcdir/"{src,pkg} "$pkgdir/$GOPATH"

# Package license (if available)
for f in LICENSE COPYING LICENSE.* COPYING.*; do
if [ -e "$srcdir/src/$_gourl/$f" ]; then
install -Dm644 "$srcdir/src/$_gourl/$f" \
"$pkgdir/usr/share/licenses/$pkgname/$f"
fi
done
}

# vim:set ts=2 sw=2 et:</nowiki>}}

上記の PKBUILD は Rémy Oudompheng‎ が作成しました。

==== ''go get'' を使う ====

build() や package() 関数を修正する必要は全くありません。変数だけを修正してください (pkgname など)。

以下の方法が使えない場合、まずは go get をテストしてみてください。

{{bc|<nowiki># Maintainer: NAME <EMAIL>

pkgname=PACKAGE NAME
pkgver=1.2.3
pkgrel=1
pkgdesc="PACKAGE DESCRIPTION"
arch=('x86_64' 'i686')
url="http://SERVER/$pkgname/"
license=('MIT')
makedepends=('go' 'git')
options=('!strip' '!emptydirs')
_gourl=SERVER.NET/PATH/MODULENAME

build() {
export GOROOT=/usr/lib/go

rm -rf build
mkdir -p build/go
cd build/go

for f in "$GOROOT/"*; do
ln -s "$f"
done

rm pkg
mkdir pkg
cd pkg

for f in "$GOROOT/pkg/"*; do
ln -s "$f"
done

platform=`for f in "$GOROOT/pkg/"*; do echo \`basename $f\`; done|grep linux`

rm "$platform"
mkdir "$platform"
cd "$platform"

for f in "$GOROOT/pkg/$platform/"*.h; do
ln -s "$f"
done

export GOROOT="$srcdir/build/go"
export GOPATH="$srcdir/build"

go get -fix "$_gourl"

# Prepare executable
if [ -d "$srcdir/build/src" ]; then
cd "$srcdir/build/src/$_gourl"
go build -o "$srcdir/build/$pkgname"
else
echo 'Old sources for a previous version of this package are already present!'
echo 'Build in a chroot or uninstall the previous version.'
return 1
fi
}

package() {
export GOROOT="$GOPATH"

# Package go package files
for f in "$srcdir/build/go/pkg/"* "$srcdir/build/pkg/"*; do
# If it's a directory
if [ -d "$f" ]; then
cd "$f"
mkdir -p "$pkgdir/$GOROOT/pkg/`basename $f`"
for z in *; do
# Check if the directory name matches
if [ "$z" == `echo $_gourl | cut -d/ -f1` ]; then
cp -r $z "$pkgdir/$GOROOT/pkg/`basename $f`"
fi
done
cd ..
fi
done

# Package source files
if [ -d "$srcdir/build/src" ]; then
mkdir -p "$pkgdir/$GOROOT/src/pkg"
cp -r "$srcdir/build/src/"* "$pkgdir/$GOROOT/src/pkg/"
find "$pkgdir" -depth -type d -name .git -exec rm -r {} \;
fi

# Package license (if available)
for f in LICENSE COPYING; do
if [ -e "$srcdir/build/src/$_gourl/$f" ]; then
install -Dm644 "$srcdir/build/src/$_gourl/$f" \
"$pkgdir/usr/share/licenses/$pkgname/$f"
fi
done

# Package executables
if [ -e "$srcdir/build/$pkgname" ]; then
install -Dm755 "$srcdir/build/$pkgname" \
"$pkgdir/usr/bin/$pkgname"
fi
}

# vim:set ts=2 sw=2 et:</nowiki>}}

← 古い版		2023年6月26日 (月) 21:59時点における版
69行目:		69行目:
	{{Warning\|ビルドフラグがコンパイラに正しく渡されたことを確認するのはパッケージャーの責任です。{{ic\|Makefile}} がある場合はそれを読みます。}}		{{Warning\|ビルドフラグがコンパイラに正しく渡されたことを確認するのはパッケージャーの責任です。{{ic\|Makefile}} がある場合はそれを読みます。}}

			==== デバッグパッケージのサポート ====
	==== Supporting debug packages ====

			ソースリストと適切なシンボルルックアップを使用してデバッグパッケージを有効にするには、デフォルトのビルドフラグをいくつか変更する必要があります。
	Enabling debug packages with source listing and proper symbol look ups require a few modifications to the default buildflags.

			* ソースパスがバイナリで確実に書き換えられるようにするため、{{ic\|-trimpath}} を削除
	* Removal of {{ic\|-trimpath}} to ensure source paths are rewritten in the binary
			* 現在のツールは圧縮ヘッダーをサポートしていないため、DWARF ヘッダーを確実に解析できるように、{{ic\|1=-compressdwarf=false}} を {{ic\|-ldflags}} に含めます。
	* Include {{ic\|1=-compressdwarf=false}} in {{ic\|-ldflags}} to ensure we can parse the DWARF headers as current tooling does not support compressed headers.
			* Go が使用する内部リンカーとして {{ic\|1=-linkmode=external}} がバイナリにビルド ID を埋め込まないようにしてください。
	* Ensure {{ic\|1=-linkmode=external}} as the internal linker go uses does not embed a build-id into the binary.
	* ~~Include~~ {{ic\|1=GOPATH="${srcdir}"}} so ''makepkg'' ~~can include the source code for all modules.~~		* {{ic\|1=GOPATH="${srcdir}"}} を含めると、''makepkg'' にすべてのモジュールのソースコードを含めることができます。

			上記のオプションは、デバッガーが選択できる、適切に分離されたシンボルとソースリストを含むデバッグパッケージを生成する必要があります。
	The above options should produce a debug package with proper detached symbols and source listings which can then be picked up by the debugger.

	{{bc\|1=		{{bc\|1=

← 古い版		2023年6月26日 (月) 21:57時点における版
58行目:		58行目:
	}}		}}

	==== ~~Flag meaning~~ ====		==== フラグの意味 ====

	* {{ic\|1=-buildmode=pie}} ~~enables~~ [[Wikipedia:~~Position-independent code~~\|PIE ~~compilation~~]] ~~for binary harderning.~~		* {{ic\|1=-buildmode=pie}} バイナリ強化のために [[Wikipedia:ja:位置独立コード\|PIE コンパイル]] を有効にします。
			* {{ic\|-trimpath}} [[再現性のあるビルド]] にとって重要であるため、完全なビルドパスとモジュールパスは埋め込まれません。
	* {{ic\|-trimpath}} important for [[reproducible builds]] so full build paths and module paths are not embedded.
			* {{ic\|1=-mod=readonly}} どの go アクションでもモジュールファイルが更新されていないことを確認してください。
	* {{ic\|1=-mod=readonly}} ensure the module files are not updated in any go actions.
			* {{ic\|-modcacherw}} は重要ではありませんが、これにより go モジュールが書き込み可能なパスを作成することが保証されます。デフォルトは読み取り専用です。
	* {{ic\|-modcacherw}} is not important, but it ensures that go modules creates a write-able path. Default is read-only.

	{{Tip\|~~When package sources include a~~ {{ic\|~~vendor~~}} ~~directory with~~ {{ic\|~~modules.txt~~}}~~, the~~ {{ic\|-mod}} ~~flag can safely be changed to~~ {{ic\|1=-mod=vendor}}.}}		{{Tip\|パッケージソースに {{ic\|modules.txt}} を含む {{ic\|vendor}} ディレクトリが含まれている場合、{{ic\|-mod}} フラグを次のように安全に変更できます。{{ic\|1=-mod=vendor}}.}}

			{{Warning\|ビルドフラグがコンパイラに正しく渡されたことを確認するのはパッケージャーの責任です。{{ic\|Makefile}} がある場合はそれを読みます。}}
	{{Warning\|It is up to the packager to verify the build flags are passed correctly to the compiler. Read the {{ic\|Makefile}} if there is one.}}

	==== Supporting debug packages ====		==== Supporting debug packages ====