Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

[インデックス 11670] ファイルの概要

このコミットは、Goプロジェクトのmisc/osxディレクトリ内のmacOS向けパッケージングスクリプトに関する変更を扱っています。具体的には、ディスクイメージ作成スクリプトimage.bashの削除、ユーティリティスクリプトutils.bashの削除、そして主要なパッケージ作成スクリプトpackage.bashの更新、および関連するREADMEファイルの修正が含まれています。これらの変更は、Goのビルドおよび配布プロセスにおけるdistツールの導入と連携を目的としています。

コミット

commit eb039a80456105d7a3df99589982215f1200152a
Author: Andrew Gerrand <adg@golang.org>
Date:   Tue Feb 7 14:37:57 2012 +1100

    misc/osx: update for dist tool, drop image.bash, update readme
    
    R=golang-dev, r
    CC=golang-dev
    https://golang.org/cl/5639043

GitHub上でのコミットページへのリンク

https://github.com/golang/go/commit/eb039a80456105d7a3df99589982215f1200152a

元コミット内容

misc/osx: update for dist tool, drop image.bash, update readme

変更の背景

このコミットの主な背景は、Goプロジェクトにおけるビルドおよび配布プロセスの標準化と効率化です。特にmacOS向けのパッケージングにおいて、従来のimage.bashスクリプトによるディスクイメージ作成プロセスが、Goの内部的なdistツールとの連携を考慮して不要と判断されたため削除されました。また、utils.bashに集約されていたユーティリティ関数の役割も、package.bashに直接組み込まれるか、あるいはdistツールによって代替されることになりました。これにより、macOS向けパッケージ作成のワークフローが簡素化され、より一貫性のあるビルドシステムに統合されることが意図されています。

前提知識の解説

Goのビルドと配布（distツール）

Go言語は、その設計思想としてクロスコンパイルの容易さを重視しています。go buildコマンドは、GOOS（ターゲットOS）とGOARCH（ターゲットアーキテクチャ）環境変数を設定することで、異なるプラットフォーム向けのバイナリを簡単に生成できます。

ここで言及されている「distツール」は、一般のGo開発者が自身のアプリケーションを配布するために使うgo buildやGoReleaserのようなツールとは異なります。Goの文脈における「go dist」コマンドは、Goツールチェイン自体がGoディストリビューションをビルドするために使用する内部コマンドです。これは、GoのソースコードからGoコンパイラ、標準ライブラリ、その他のツールをビルドし、配布可能な形式にパッケージ化するプロセスを管理します。このコミットは、Goの公式ディストリビューションをmacOS向けに作成する内部プロセスの一部を改善するものです。

macOSパッケージングの基礎

macOSでは、アプリケーションやシステムコンポーネントのインストールに.pkgファイル（インストーラパッケージ）や.dmgファイル（ディスクイメージ）が一般的に使用されます。

  • .pkgファイル: macOS Installerによって実行されるパッケージファイルで、アプリケーションのバイナリ、ライブラリ、設定ファイルなどを特定のパスに配置するためのスクリプトやメタデータを含みます。PackageMakerツール（Apple Developer Toolsの一部）を使用して作成されます。
  • .dmgファイル: ディスクイメージファイルで、仮想的なディスクとしてマウントされます。通常、.pkgファイルやアプリケーションバンドル（.app）が内部に含まれており、ユーザーはこれをドラッグ＆ドロップでアプリケーションフォルダにコピーすることでインストールを完了します。

シェルスクリプトの役割

このコミットで変更されているファイルは、すべてBashシェルスクリプトです。

  • image.bash: 以前は.pkgファイルを作成した後、それを.dmgファイルに含めるためのスクリプトでした。
  • package.bash: .pkgファイル自体を作成するための主要なスクリプトです。Goのソースコードをビルドし、PackageMakerを使ってインストーラパッケージを生成します。
  • utils.bash: package.bashやimage.bashで共通して使用されるユーティリティ関数（例: PackageMakerやhdiutilなどの外部ツールのパスを特定する機能）を定義していました。

技術的詳細

このコミットの技術的なポイントは、GoのmacOS向け配布物作成プロセスにおける依存関係の合理化と、distツールへの統合です。

  1. image.bashの削除:

    • 以前はpackage.bashで作成された.pkgファイルをさらに.dmgファイルにラップするためにimage.bashが使用されていました。
    • このコミットによりimage.bashが完全に削除されました。これは、Goの配布戦略において、.dmg形式での提供が不要になったか、あるいはdistツールが直接.pkgファイルを生成するようになったことを示唆しています。READMEの変更からも、ディスクイメージが「厳密には不要」であり、「慣習的に一般的」であったという記述が削除され、package.bashが直接.pkgファイルを生成することが強調されています。
    • hdiutil（ディスクイメージ操作ツール）やosascript（AppleScript実行ツール）への依存も、image.bashの削除に伴いなくなりました。

  2. utils.bashの削除と機能のインライン化:

    • utils.bashは、PackageMakerなどの外部ツールのパスを特定する共通ロジックを提供していました。
    • このスクリプトが削除され、その機能（特にPackageMakerのパス特定ロジック）はpackage.bashに直接組み込まれました。これにより、スクリプト間の依存関係が減り、package.bashが自己完結的になりました。

  3. package.bashの更新:

    • distツールとの連携: package.bashは、Goのバージョン情報を取得するためにsrc/version.bash -saveの代わりにsrc/make.bash --dist-toolと../bin/tool/dist versionを使用するようになりました。これは、Goのビルドシステムがdistツールを通じてバージョン管理を一元化していることを示しています。distツールはGoの内部ビルドプロセスにおいて、バージョン情報の取得やビルド成果物の管理を行う役割を担っています。
    • エラー出力のリダイレクト: echoコマンドの出力が>&2（標準エラー出力）にリダイレクトされるようになりました。これは、スクリプトの進行状況やデバッグ情報を標準出力ではなく標準エラー出力に送ることで、スクリプトの実際の出力（この場合は生成されるパッケージファイル名など）と区別しやすくするための一般的なプラクティスです。
    • 一時ディレクトリのクリーンアップ: trap "rm -rf $BUILD" 0が追加されました。これは、スクリプトが正常終了した場合でも、エラーで終了した場合でも、一時ビルドディレクトリ$BUILDを確実に削除するためのものです。これにより、ビルドプロセスがより堅牢になります。
    • パッケージ名の変更: 生成されるパッケージファイル名が、以前のGo hg id.pkgからgo.darwin.$VERSION.pkgに変更されました。これは、バージョン情報がファイル名に明示的に含まれるようになり、より体系的な命名規則になったことを示します。hg idはMercurialのリビジョンIDですが、GoプロジェクトがGitに移行した現在では、この部分はGitのコミットハッシュやタグに相当する情報に置き換えられるか、あるいはdistツールが提供する正式なバージョン文字列が使用されます。

これらの変更は、GoのmacOS向け配布物作成プロセスをより現代的で、Goの内部ビルドシステムと密接に連携するように進化させる一環です。

コアとなるコードの変更箇所

このコミットでは以下のファイルが変更されています。

  • misc/osx/README: 10行変更 (2追加, 8削除)
  • misc/osx/ReadMe.txt: 削除 (4行削除)
  • misc/osx/image.bash: 削除 (38行削除)
  • misc/osx/package.bash: 52行変更 (35追加, 17削除)
  • misc/osx/utils.bash: 削除 (31行削除)

主な変更点:

  • image.bashとutils.bashが完全に削除されました。
  • package.bashが大幅に修正され、distツールとの連携、バージョン情報の取得方法の変更、PackageMakerのパス特定ロジックのインライン化、一時ディレクトリのクリーンアップ強化、および出力ファイル名の変更が行われました。
  • READMEファイルが更新され、image.bashに関する記述が削除され、package.bashの役割が明確化されました。
  • ReadMe.txtという古いドキュメントファイルが削除されました。

コアとなるコードの解説

misc/osx/READMEの変更

--- a/misc/osx/README
+++ b/misc/osx/README
@@ -1,9 +1,3 @@
-Use image.bash to construct a disk image.
+Use package.bash to construct a package file (Go.pkg) for installation on OS X.
 
-package.bash constructs a package file (Go.pkg) for installation on OS X, and
-is used by image.bash to construct a disk image. Strictly speaking, the disk
-image is unnecessary, but they are more common by convention.
-\
-These scripts depend on PackageMaker (Developer Tools), osascript, and hdiutil.
-Appropriate checks are run in utils.bash, called at the beginning of each
-script.
+This script depends on PackageMaker (Developer Tools).

image.bashに関する記述が削除され、package.bashが直接macOS用のパッケージファイル（Go.pkg）を構築する役割を持つことが明確にされました。また、osascriptとhdiutilへの依存がなくなったことも反映されています。

misc/osx/ReadMe.txtの削除

このファイルは、Goのインストールに関する古い情報を含んでいたため削除されました。

misc/osx/image.bashの削除

ディスクイメージ（.dmg）を作成するためのスクリプトが完全に削除されました。これにより、GoのmacOS向け配布物は、直接.pkgファイルとして提供されるか、あるいは別のメカニズムで.dmgが生成されることになります。

misc/osx/package.bashの変更

--- a/misc/osx/package.bash
+++ b/misc/osx/package.bash
@@ -5,45 +5,65 @@
 
 set -e
 
-source utils.bash
+if ! test -f ../../src/all.bash; then
+\techo >&2 \"package.bash must be run from $GOROOT/misc/osx\"\
+\texit 1
+fi
 
-if ! test -f ../../src/env.bash; then
-\techo \"package.bash must be run from $GOROOT/misc/osx\" 1>&2
+echo >&2 \"Locating PackageMaker...\"\
+PM=/Applications/Utilities/PackageMaker.app/Contents/MacOS/PackageMaker\
+if [ ! -x $PM ]; then
+\tPM=/Developer$PM\
+\tif [ ! -x $PM ]; then
+\t\techo >&2 \"could not find PackageMaker; aborting\"\
+\t\texit 1
+\tfi
+fi\
+echo >&2 \"  Found: $PM\"\
+
+BUILD=/tmp/go.build.tmp
+ROOT=`hg root`
+export GOROOT=$BUILD/root/usr/local/go
+export GOROOT_FINAL=/usr/local/go
+
+echo >&2 \"Removing old images\"\
+rm -f *.pkg *.dmg
+
+echo >&2 \"Preparing temporary directory\"\
+rm -rf $BUILD
+mkdir -p $BUILD
+trap \"rm -rf $BUILD\" 0
+
+echo >&2 \"Copying go source distribution\"\
+mkdir -p $BUILD/root/usr/local
+cp -r $ROOT $GOROOT
+cp -r etc $BUILD/root/etc
+
+echo >&2 \"Detecting version...\"\
+pushd src > /dev/null
+./make.bash --dist-tool > /dev/null
+../bin/tool/dist version > /dev/null
+popd > /dev/null
+mv VERSION.cache VERSION
+VERSION=\"$(cat VERSION | awk \'{ print $1 }\')\"\
+echo >&2 \"  Version: $VERSION\"\
+
+echo >&2 \"Pruning Mercurial metadata\"\
+rm -rf .hg .hgignore .hgtags
+
+echo >&2 \"Building Go\"\
+pushd src
+./all.bash 2>&1 | sed \"s/^/  /\" >&2
+popd > /dev/null
+
+popd > /dev/null
+
+echo >&2 \"Building package\"\
+$PM -v -r $BUILD/root -o \"go.darwin.$VERSION.pkg\" \\\
+\t--scripts scripts \\\
+\t--id com.googlecode.go \\\
+\t--title Go \\\
+\t--version \"0.1\" \\\
+\t--target \"10.5\"
  • source utils.bashの削除: utils.bashが削除されたため、その呼び出しも削除されました。
  • PackageMakerのパス特定ロジックのインライン化: utils.bashで行われていたPackageMakerのパス特定が、package.bashの冒頭に直接記述されました。これにより、スクリプトが自己完結的になりました。
  • バージョン検出の変更:
    • 以前はsrc/version.bash -saveを使っていましたが、新しいコードではsrc/make.bash --dist-toolを実行し、その後../bin/tool/dist versionを使ってバージョン情報を取得しています。これは、Goのビルドシステムがdistツールを通じてバージョン管理を一元化していることを示しています。
    • 取得したバージョンはVERSION.cacheに保存され、VERSIONにリネームされた後、awkコマンドで整形されてVERSION変数に格納されます。
  • 一時ディレクトリのクリーンアップ強化: trap "rm -rf $BUILD" 0が追加され、スクリプトの終了時に一時ビルドディレクトリが確実に削除されるようになりました。
  • パッケージ名の変更: 生成されるパッケージファイル名が、Go hg id.pkgからgo.darwin.$VERSION.pkgに変更されました。これにより、パッケージ名にGoのバージョンが明示的に含まれるようになります。
  • 標準エラー出力へのリダイレクト: 多くのechoコマンドの出力が>&2（標準エラー出力）にリダイレクトされ、スクリプトの進行状況がより適切に報告されるようになりました。

misc/osx/utils.bashの削除

PackageMakerやhdiutil、osascriptといった外部ツールのパスを特定するユーティリティ関数を提供していたこのスクリプトは、その機能がpackage.bashにインライン化されたため削除されました。

関連リンク

参考にした情報源リンク