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

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

このコミットは、Go言語のビルドシステムにおける一時的な変更を記録しています。具体的には、ビルドログから詳細なタイミング情報を取得するために、意図的にビルドを失敗させるように変更が加えられました。これは、通常成功するビルドのログが詳細に記録されないという当時のCIシステム(おそらくGoのTryBotシステム)の制約を回避するための、診断目的の一時的な措置でした。

コミット

commit 46437f0028b2a3332339992c1b5867f039fee06e
Author: Russ Cox <rsc@golang.org>
Date:   Mon Jul 29 16:52:03 2013 -0400

    build: break builds
    
    I want to see the timing information in build logs,
    and we can't see the logs for "ok" builds.
    So make the build fail everywhere.
    
    Will roll back immediately.
    
    TBR=dvyukov
    CC=golang-dev
    https://golang.org/cl/12058046

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

https://github.com/golang/go/commit/46437f0028b2a3332339992c1b5867f039fee06e

元コミット内容

build: break builds

I want to see the timing information in build logs,
and we can't see the logs for "ok" builds.
So make the build fail everywhere.

Will roll back immediately.

TBR=dvyukov
CC=golang-dev
https://golang.org/cl/12058046

変更の背景

このコミットの主な背景は、Goプロジェクトの継続的インテグレーション(CI)システム、特に当時のTryBotシステムにおけるログの可視性の問題にありました。

当時のGoプロジェクトのCIシステムでは、ビルドやテストが成功した場合("ok"ビルド)、その詳細なログが自動的に破棄されるか、あるいはアクセスが困難になるという運用上の制約があったと考えられます。しかし、開発者、特にGoの主要な貢献者であるRuss Cox氏は、ビルドやテストの実行にかかる「タイミング情報」を詳細に分析する必要がありました。これは、パフォーマンスのボトルネックを特定したり、ビルド時間の最適化を図ったりするために不可欠な情報です。

成功したビルドのログが見られないという制約がある中で、タイミング情報を取得する唯一の方法は、ビルドを意図的に失敗させることでした。ビルドが失敗すれば、その失敗の原因究明のために詳細なログが保持され、アクセス可能になるためです。

したがって、このコミットは、ビルドシステム全体の健全性やパフォーマンスに関する診断情報を一時的に収集するための、非常に限定的かつ一時的な「ハック」として導入されました。コミットメッセージに「Will roll back immediately.(すぐに元に戻す)」と明記されていることからも、これが恒久的な変更ではなく、特定の目的のための短期間の措置であったことが強く示唆されています。

前提知識の解説

このコミットを理解するためには、以下の概念について知っておく必要があります。

1. Go言語のビルドシステムとsrc/run.bash

Go言語のプロジェクトは、そのソースコードをビルドし、テストを実行するための独自のスクリプト群を持っています。src/run.bashは、Goのソースツリーのルートにある重要なシェルスクリプトの一つで、Goのビルド、テスト、およびその他の開発関連タスクを実行するための主要なエントリポイントとして機能します。これは、Goの標準ライブラリやツールチェイン全体のビルドとテストをオーケストレーションするために使用されます。

2. 継続的インテグレーション (CI) とTryBotシステム

継続的インテグレーション(CI)は、ソフトウェア開発において、開発者がコードベースに加えた変更を頻繁に統合し、自動的にビルドおよびテストを行うプラクティスです。これにより、問題の早期発見と修正が可能になります。

Goプロジェクトでは、当時から「TryBot」と呼ばれる独自のCIシステムが運用されていました。開発者がコードレビューシステム(Gerritなど)にコード変更(Change-list, CL)を提出すると、TryBotがその変更を自動的にビルドし、テストを実行して、変更が既存のコードベースを壊さないことを検証します。このTryBotの実行結果(成功/失敗)と、その際のログが開発者にフィードバックされます。

3. ビルドログとタイミング情報

ビルドログは、ソフトウェアのビルドプロセス中に生成される詳細な出力です。これには、コンパイルの進行状況、警告、エラー、そして各ステップにかかった時間などの情報が含まれます。

「タイミング情報」とは、ビルドの各フェーズ(例:コンパイル、リンク、テスト実行)がどれくらいの時間を要したかを示すデータです。この情報は、ビルドプロセスのボトルネックを特定し、最適化の機会を見つけるために非常に重要です。例えば、特定のパッケージのコンパイルに異常に時間がかかっている場合、その原因を調査し、改善策を講じることができます。

4. exit 1 コマンド

Unix/Linux系のシェルスクリプトにおいて、exitコマンドはスクリプトの実行を終了させます。exitに続く数値は「終了ステータス」と呼ばれ、スクリプトがどのように終了したかを示します。

  • exit 0: 慣例的に、スクリプトが正常に終了したことを示します。
  • exit 1 (または0以外の値): 慣例的に、スクリプトがエラーまたは異常な状態で終了したことを示します。

CIシステムは、この終了ステータスをチェックして、ビルドやテストが成功したか失敗したかを判断します。exit 1を明示的に呼び出すことで、スクリプトは意図的に失敗したとCIシステムに報告します。

技術的詳細

このコミットの技術的な変更は非常に単純ですが、その意図は前述の背景と密接に関連しています。

変更はsrc/run.bashファイルに対して行われました。このスクリプトは、Goのビルドとテストの実行フローを制御するものです。通常、スクリプトの最後にecho ALL TESTS PASSEDというメッセージが出力され、その後スクリプトは正常終了(exit 0に相当)します。

このコミットでは、そのecho ALL TESTS PASSEDの直後に、exit 1という行が追加されました。

これにより、src/run.bashが実行されると、たとえすべてのビルドとテストが内部的に成功していたとしても、スクリプトの最終的な終了ステータスは1となります。CIシステムはこの終了ステータスを検知し、「ビルドが失敗した」と判断します。

この「失敗」は、実際のコードのバグやビルドエラーによるものではなく、スクリプトの意図的な操作によるものです。この人工的な失敗により、CIシステムは「失敗したビルドのログ」として、通常は破棄されるはずの詳細なタイミング情報を含むログを保持し、開発者がアクセスできるようにしました。

これは、CIシステムが成功時のログを詳細に保持しないという当時の制約に対する、直接的かつ効果的な回避策でした。Russ Cox氏は、この変更を適用し、必要なタイミング情報を収集した後、すぐにこの変更を元に戻す計画であったことをコミットメッセージで明確に述べています。

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

変更はsrc/run.bashファイルのみです。

--- a/src/run.bash
+++ b/src/run.bash
@@ -185,3 +185,5 @@ go tool api -c $GOROOT/api/go1.txt,$GOROOT/api/go1.1.txt -next $GOROOT/api/next.\
 
 echo
 echo ALL TESTS PASSED
+
+exit 1

コアとなるコードの解説

変更は、src/run.bashスクリプトの末尾にexit 1という行を追加した点に集約されます。

  • src/run.bash: Goプロジェクトのビルドとテストを実行するためのメインのシェルスクリプトです。このスクリプトは、Goのツールチェインのビルド、標準ライブラリのテスト、APIのチェックなど、様々なタスクを順次実行します。
  • echo ALL TESTS PASSED: この行は、スクリプトがすべてのテストを正常に完了したことを示すメッセージを標準出力に出力します。これは、スクリプトが正常に終了する直前の最終的な確認メッセージとして機能します。
  • +exit 1: この追加された行が、このコミットの核心です。
    • exitコマンドは、シェルスクリプトの実行を終了させます。
    • 1という引数は、スクリプトが「失敗」したことを示す終了ステータスです。

この変更により、src/run.bashは、たとえその前のすべてのコマンド(ビルドやテストなど)が成功していたとしても、最終的にexit 1を実行することで、CIシステムに対して「このビルドは失敗した」と報告します。これにより、CIシステムは失敗したビルドのログを保持し、開発者がそのログに含まれる詳細なタイミング情報にアクセスできるようになります。

これは、GoのCIシステムが成功したビルドのログを詳細に保持しないという当時の制約を一時的に回避するための、診断目的の非常に具体的な変更でした。

関連リンク

  • 元のChange-list (CL): https://golang.org/cl/12058046
    • このリンクは、Goのコードレビューシステム(Gerrit)におけるこのコミットに対応するChange-listを示しています。通常、より詳細な議論や、この変更がどのようにレビューされ、最終的にコミットされたかの経緯が確認できます。

参考にした情報源リンク

  • Go言語の公式ドキュメント(Goのビルドプロセスやテストに関する一般的な情報)
  • GoプロジェクトのGitHubリポジトリ (特にsrc/run.bashの歴史)
  • 継続的インテグレーションに関する一般的な知識
  • シェルスクリプトのexitコマンドに関する一般的な知識
  • (必要に応じて)当時のGoのTryBotシステムに関する公開情報や議論(Goのメーリングリストアーカイブなど)

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

このコミットは、Go言語のビルドシステムにおける一時的な変更を記録しています。具体的には、ビルドログから詳細なタイミング情報を取得するために、意図的にビルドを失敗させるように変更が加えられました。これは、通常成功するビルドのログが詳細に記録されないという当時のCIシステム(おそらくGoのTryBotシステム)の制約を回避するための、診断目的の一時的な措置でした。

コミット

commit 46437f0028b2a3332339992c1b5867f039fee06e
Author: Russ Cox <rsc@golang.org>
Date:   Mon Jul 29 16:52:03 2013 -0400

    build: break builds
    
    I want to see the timing information in build logs,
    and we can't see the logs for "ok" builds.
    So make the build fail everywhere.
    
    Will roll back immediately.
    
    TBR=dvyukov
    CC=golang-dev
    https://golang.org/cl/12058046

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

https://github.com/golang/go/commit/46437f0028b2a3332339992c1b5867f039fee06e

元コミット内容

build: break builds

I want to see the timing information in build logs,
and we can't see the logs for "ok" builds.
So make the build fail everywhere.

Will roll back immediately.

TBR=dvyukov
CC=golang-dev
https://golang.org/cl/12058046

変更の背景

このコミットの主な背景は、Goプロジェクトの継続的インテグレーション(CI)システム、特に当時のTryBotシステムにおけるログの可視性の問題にありました。

当時のGoプロジェクトのCIシステムでは、ビルドやテストが成功した場合("ok"ビルド)、その詳細なログが自動的に破棄されるか、あるいはアクセスが困難になるという運用上の制約があったと考えられます。これは、リソースの節約やログストレージの最適化といった理由によるものでした。しかし、開発者、特にGoの主要な貢献者であるRuss Cox氏は、ビルドやテストの実行にかかる「タイミング情報」を詳細に分析する必要がありました。これは、パフォーマンスのボトルネックを特定したり、ビルド時間の最適化を図ったりするために不可欠な情報です。

成功したビルドのログが見られないという制約がある中で、タイミング情報を取得する唯一の方法は、ビルドを意図的に失敗させることでした。ビルドが失敗すれば、その失敗の原因究明のために詳細なログが保持され、アクセス可能になるためです。

したがって、このコミットは、ビルドシステム全体の健全性やパフォーマンスに関する診断情報を一時的に収集するための、非常に限定的かつ一時的な「ハック」として導入されました。コミットメッセージに「Will roll back immediately.(すぐに元に戻す)」と明記されていることからも、これが恒久的な変更ではなく、特定の目的のための短期間の措置であったことが強く示唆されています。

前提知識の解説

このコミットを理解するためには、以下の概念について知っておく必要があります。

1. Go言語のビルドシステムとsrc/run.bash

Go言語のプロジェクトは、そのソースコードをビルドし、テストを実行するための独自のスクリプト群を持っています。src/run.bashは、Goのソースツリーのルートにある重要なシェルスクリプトの一つで、Goのビルド、テスト、およびその他の開発関連タスクを実行するための主要なエントリポイントとして機能します。これは、Goの標準ライブラリやツールチェイン全体のビルドとテストをオーケストレーションするために使用されます。このスクリプトは、Goのビルド環境の設定、各種テストの実行、APIの互換性チェックなど、Go開発における多くの自動化されたタスクを担っています。

2. 継続的インテグレーション (CI) とTryBotシステム

継続的インテグレーション(CI)は、ソフトウェア開発において、開発者がコードベースに加えた変更を頻繁に統合し、自動的にビルドおよびテストを行うプラクティスです。これにより、問題の早期発見と修正が可能になります。

Goプロジェクトでは、当時から「TryBot」と呼ばれる独自のCIシステムが運用されていました。開発者がコードレビューシステム(Gerritなど)にコード変更(Change-list, CL)を提出すると、TryBotがその変更を自動的にビルドし、テストを実行して、変更が既存のコードベースを壊さないことを検証します。このTryBotの実行結果(成功/失敗)と、その際のログが開発者にフィードバックされます。TryBotは、Goプロジェクトの品質と安定性を維持するための重要なゲートウェイとして機能しています。

3. ビルドログとタイミング情報

ビルドログは、ソフトウェアのビルドプロセス中に生成される詳細な出力です。これには、コンパイルの進行状況、警告、エラー、そして各ステップにかかった時間などの情報が含まれます。

「タイミング情報」とは、ビルドの各フェーズ(例:コンパイル、リンク、テスト実行)がどれくらいの時間を要したかを示すデータです。この情報は、ビルドプロセスのボトルネックを特定し、最適化の機会を見つけるために非常に重要です。例えば、特定のパッケージのコンパイルに異常に時間がかかっている場合、その原因を調査し、改善策を講じることができます。大規模なプロジェクトでは、ビルド時間のわずかな増加も開発者の生産性に大きな影響を与えるため、このようなタイミング情報の分析は不可欠です。

4. exit 1 コマンド

Unix/Linux系のシェルスクリプトにおいて、exitコマンドはスクリプトの実行を終了させます。exitに続く数値は「終了ステータス」(または終了コード)と呼ばれ、スクリプトがどのように終了したかを示します。

  • exit 0: 慣例的に、スクリプトが正常に終了したことを示します。
  • exit 1 (または0以外の値): 慣例的に、スクリプトがエラーまたは異常な状態で終了したことを示します。

CIシステムは、この終了ステータスをチェックして、ビルドやテストが成功したか失敗したかを判断します。exit 1を明示的に呼び出すことで、スクリプトは意図的に失敗したとCIシステムに報告します。これにより、CIシステムは失敗時の処理フロー(ログの保持など)を実行します。

技術的詳細

このコミットの技術的な変更は非常に単純ですが、その意図は前述の背景と密接に関連しています。

変更はsrc/run.bashファイルに対して行われました。このスクリプトは、Goのビルドとテストの実行フローを制御するものです。通常、スクリプトの最後にecho ALL TESTS PASSEDというメッセージが出力され、その後スクリプトは正常終了(exit 0に相当)します。

このコミットでは、そのecho ALL TESTS PASSEDの直後に、exit 1という行が追加されました。

これにより、src/run.bashが実行されると、たとえすべてのビルドとテストが内部的に成功していたとしても、スクリプトの最終的な終了ステータスは1となります。CIシステムはこの終了ステータスを検知し、「ビルドが失敗した」と判断します。

この「失敗」は、実際のコードのバグやビルドエラーによるものではなく、スクリプトの意図的な操作によるものです。この人工的な失敗により、CIシステムは「失敗したビルドのログ」として、通常は破棄されるはずの詳細なタイミング情報を含むログを保持し、開発者がアクセスできるようにしました。

これは、CIシステムが成功時のログを詳細に保持しないという当時の制約に対する、直接的かつ効果的な回避策でした。Russ Cox氏は、この変更を適用し、必要なタイミング情報を収集した後、すぐにこの変更を元に戻す計画であったことをコミットメッセージで明確に述べています。このような一時的な変更は、デバッグや診断の目的で、通常の運用フローでは得られない情報を取得するために、開発現場で時折用いられる手法です。

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

変更はsrc/run.bashファイルのみです。

--- a/src/run.bash
+++ b/src/run.bash
@@ -185,3 +185,5 @@ go tool api -c $GOROOT/api/go1.txt,$GOROOT/api/go1.1.txt -next $GOROOT/api/next.\
 
 echo
 echo ALL TESTS PASSED
+
+exit 1

コアとなるコードの解説

変更は、src/run.bashスクリプトの末尾にexit 1という行を追加した点に集約されます。

  • src/run.bash: Goプロジェクトのビルドとテストを実行するためのメインのシェルスクリプトです。このスクリプトは、Goのツールチェインのビルド、標準ライブラリのテスト、APIのチェックなど、様々なタスクを順次実行します。その実行結果は、Goの継続的インテグレーションシステム(TryBotなど)によって監視されます。
  • echo ALL TESTS PASSED: この行は、スクリプトがすべてのテストを正常に完了したことを示すメッセージを標準出力に出力します。これは、スクリプトが正常に終了する直前の最終的な確認メッセージとして機能し、開発者やCIシステムに対して、テストスイートが問題なく実行されたことを視覚的に伝えます。
  • +exit 1: この追加された行が、このコミットの核心です。
    • exitコマンドは、シェルスクリプトの実行を終了させます。
    • 1という引数は、スクリプトが「失敗」したことを示す終了ステータスです。Unix/Linuxシステムでは、終了ステータス0は成功を意味し、0以外の値はエラーや異常終了を意味します。

この変更により、src/run.bashは、たとえその前のすべてのコマンド(ビルドやテストなど)が成功していたとしても、最終的にexit 1を実行することで、CIシステムに対して「このビルドは失敗した」と報告します。これにより、CIシステムは失敗したビルドのログを保持し、開発者がそのログに含まれる詳細なタイミング情報にアクセスできるようになります。

これは、GoのCIシステムが成功したビルドのログを詳細に保持しないという当時の制約を一時的に回避するための、診断目的の非常に具体的な変更でした。この変更は、Goのビルドプロセスの健全性を維持し、パフォーマンスを最適化するための情報収集という、重要な目的のために行われたものです。

関連リンク

  • 元のChange-list (CL): https://golang.org/cl/12058046
    • このリンクは、Goのコードレビューシステム(Gerrit)におけるこのコミットに対応するChange-listを示しています。通常、より詳細な議論や、この変更がどのようにレビューされ、最終的にコミットされたかの経緯が確認できます。

参考にした情報源リンク

  • Go言語の公式ドキュメント(Goのビルドプロセスやテストに関する一般的な情報)
  • GoプロジェクトのGitHubリポジトリ (特にsrc/run.bashの歴史)
  • 継続的インテグレーションに関する一般的な知識
  • シェルスクリプトのexitコマンドに関する一般的な知識
  • Go TryBot system 2013 build logs timing informationに関するWeb検索結果(成功ビルドのログが当時アクセスしにくかったという状況を裏付ける情報)