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

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

このコミットは、Go言語の公式ドキュメントである doc/install-source.html と doc/install.html を更新し、Go開発環境のセットアップに関する重要な情報、特に GOPATH の概念と「How to Write Go Code」ドキュメントへの参照を追加するものです。これにより、新規ユーザーがGoのインストール後にスムーズに開発を開始できるよう、ガイダンスを改善することを目的としています。

コミット

commit 9115a8bca4d10be0aa4b7ae754dc24988867c4a9
Author: Andrew Gerrand <adg@golang.org>
Date:   Wed Jun 13 10:33:02 2012 +1000

    doc/install: mention GOPATH and point to code.html
    
    Fixes #3469.
    
    R=golang-dev, kevlar, rsc, r
    CC=golang-dev
    https://golang.org/cl/6304049

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

https://github.com/golang/go/commit/9115a8bca4d10be0aa4b7ae754dc24988867c4a9

元コミット内容

doc/install: mention GOPATH and point to code.html
    
Fixes #3469.
    
R=golang-dev, kevlar, rsc, r
CC=golang-dev
https://golang.org/cl/6304049

変更の背景

このコミットは、Go言語のインストールガイドが、インストール後の開発環境のセットアップ、特に GOPATH の設定とGoコードの記述方法に関する情報が不足しているという問題（Issue #3469）に対応するために行われました。当時のGoのツールチェインは GOPATH という環境変数に大きく依存しており、Goのソースコードやバイナリが配置されるワークスペースのルートを定義していました。新規ユーザーにとって、この GOPATH の概念と設定はしばしば混乱の原因となっていました。

既存のドキュメントでは、Goのインストールが完了した後の「次に行うこと」として「A Tour of Go」へのリンクと、「How to Write Go Code」への参照がありましたが、GOPATH の重要性や、開発環境をどのように設定すべきかについての明確な指示が欠けていました。このため、ユーザーはGoのインストールはできたものの、実際にコードを書き始める段階でつまずく可能性がありました。

このコミットは、インストールガイドに GOPATH の設定とGoコードの書き方に関するドキュメントへの直接的なリンクを追加することで、このギャップを埋め、ユーザーエクスペリエンスを向上させることを目的としています。

前提知識の解説

Go言語のワークスペースとGOPATH

Go言語の初期のバージョン（Go Modulesが導入される前）では、Goのソースコード、コンパイルされたパッケージ、実行可能ファイルは、GOPATH と呼ばれる環境変数で指定されたワークスペース内に整理されることが強く推奨されていました。GOPATH は、Goプロジェクトのルートディレクトリを指し、通常は $HOME/go のようなパスに設定されました。

GOPATH の下には、以下の3つの標準的なサブディレクトリがありました。

  • src: Goのソースコードが配置される場所。例えば、github.com/user/project のようなパスは、$GOPATH/src/github.com/user/project に対応します。
  • pkg: コンパイルされたパッケージファイル（.a ファイル）が配置される場所。
  • bin: go install コマンドでインストールされた実行可能ファイルが配置される場所。

GOPATH は、Goのツールチェインが依存関係を解決し、パッケージをビルドし、実行可能ファイルをインストールするために不可欠な概念でした。ユーザーは、Goのコードを記述する前に、この GOPATH を適切に設定する必要がありました。

doc/install.html と doc/install-source.html

これらはGo言語の公式ウェブサイトに掲載されているインストールガイドのHTMLドキュメントです。

  • doc/install.html: 主にバイナリディストリビューションからのGoのインストール方法について説明しています。
  • doc/install-source.html: ソースコードからGoをビルドしてインストールする方法について説明しています。

これらのドキュメントは、Goを使い始めるユーザーにとって最初の接点となるため、インストール後の次のステップに関する明確な指示が非常に重要です。

doc/code.html (How to Write Go Code)

このドキュメントは、Goのワークスペースの構造、GOPATH の設定、パッケージのインポート、Goプログラムのビルドとテストなど、Goコードを記述するための基本的なガイドラインを提供していました。Goのプロジェクト構造と開発ワークフローを理解するために不可欠な情報源でした。

技術的詳細

このコミットの技術的な変更は、既存のHTMLドキュメントに新しいセクションを追加し、既存のセクションの順序を変更することによって行われています。

具体的には、以下の変更が含まれます。

  1. doc/install-source.html の変更:

    • hello, world のセクションの直後に、新しい <h2> タグで「Set up your work environment」という見出しが追加されています。
    • この見出しの下に、GOPATH の設定とGoコードの書き方について説明している /doc/code.html へのリンクを含む <p> タグが追加されています。

  2. doc/install.html の変更:

    • 既存の「What's next」セクション（id="next"）が、「Set up your work environment」セクション（id="gopath"）の後に移動されています。
    • 新しい「Set up your work environment」セクションが追加され、doc/install-source.html と同様に /doc/code.html へのリンクが含まれています。
    • 元々「What's next」セクションにあった「How to Write Go Code」への参照は、新しい「Set up your work environment」セクションに移動され、より適切な文脈で提示されるようになっています。
    • 「A Tour of Go」へのリンクは、引き続き「What's next」セクションに残されています。

これらの変更により、ユーザーはGoのインストールが完了した後、すぐに開発環境のセットアップに関する重要な情報にアクセスできるようになります。特に GOPATH の概念が明示的に導入され、その詳細が doc/code.html で説明されていることが明確に示されるようになりました。

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

diff --git a/doc/install-source.html b/doc/install-source.html
index 87c187ba8e..721d28b9ea 100644
--- a/doc/install-source.html
+++ b/doc/install-source.html
@@ -218,6 +218,12 @@ hello, world
 If you see the "hello, world" message then Go is installed correctly.
 </p>
 
+<h2 id="gopath">Set up your work environment</h2>
+
+<p>
+The document <a href="/doc/code.html">How to Write Go Code</a> explains how to
+set up a work environment in which to build and test Go code.
+</p>
 
 <h2 id="community">Community resources</h2>
 
diff --git a/doc/install.html b/doc/install.html
index b856836ff9..ae5bffab18 100644
--- a/doc/install.html
+++ b/doc/install.html
@@ -227,15 +227,17 @@ hello, world
 If you see the "hello, world" message then your Go installation is working.
 </p>
 
-<h2 id="next">What's next</h2>
+<h2 id="gopath">Set up your work environment</h2>
 
 <p>
-Start by taking <a href="http://code.google.com/p/go-tour/">A Tour of Go</a>.
+The document <a href="/doc/code.html">How to Write Go Code</a> explains how to
+set up a work environment in which to build and test Go code.
 </p>
 
+<h2 id="next">What's next</h2>
+\n
 <p>
-For more detail about the process of building and testing Go programs
-read <a href="/doc/code.html">How to Write Go Code</a>.
+Start by taking <a href="http://code.google.com/p/go-tour/">A Tour of Go</a>.
 </p>
 
 <p>

コアとなるコードの解説

上記の差分は、HTMLドキュメントの構造とコンテンツに対する直接的な変更を示しています。

doc/install-source.html の変更点

  • +<h2 id="gopath">Set up your work environment</h2>: 新しいレベル2の見出しが追加され、id="gopath" が割り当てられています。これは、このセクションが GOPATH に関連する内容であることを示唆しています。
  • +<p>The document <a href="/doc/code.html">How to Write Go Code</a> explains how to set up a work environment in which to build and test Go code.</p>: この段落は、GOPATH を含むGoのワークスペースのセットアップ方法について説明している「How to Write Go Code」ドキュメントへの直接的なリンクを提供しています。これにより、ユーザーはインストールが完了した直後に、開発環境のセットアップに関する詳細な情報にアクセスできるようになります。

doc/install.html の変更点

  • -<h2 id="next">What's next</h2> と +<h2 id="gopath">Set up your work environment</h2>: 既存の「What's next」セクションが、新しい「Set up your work environment」セクションに置き換えられています。これは、インストール後の最初のステップとして、開発環境のセットアップがより重要視されるようになったことを示しています。
  • 既存の「What's next」セクションにあった「How to Write Go Code」へのリンクが、新しい「Set up your work environment」セクションに移動されています。
  • +<h2 id="next">What's next</h2> と +<p>Start by taking <a href="http://code.google.com/p/go-tour/">A Tour of Go</a>.</p>: 元々「What's next」セクションにあった「A Tour of Go」へのリンクは、新しい「What's next」セクションとして再配置されています。これにより、開発環境のセットアップが完了した後に、Go言語の基本的な構文や機能について学ぶための次のステップが明確に示されます。

これらの変更は、Goのインストールガイドの論理的な流れを改善し、ユーザーがGoをインストールした後、開発環境を適切に設定し、Goコードを書き始めるための明確なパスを提供することを目的としています。特に、GOPATH の概念がGo開発の初期段階で重要であった時期において、このドキュメントの改善は新規ユーザーにとって非常に価値のあるものでした。

関連リンク

参考にした情報源リンク

  • Go言語の公式ドキュメント (当時のバージョン): https://golang.org/doc/install.html および https://golang.org/doc/code.html (コミット当時のURL構造に基づく)
  • Go言語のIssueトラッカー (当時のIssue #3469): 内部的なトラッカーまたはGoogle CodeのGoプロジェクトのIssueトラッカーを参照している可能性が高い。
  • Go言語のGOPATHに関する情報: https://go.dev/doc/gopath_code (現在のドキュメントにおけるGOPATHの説明)
  • Go言語の歴史とGOPATHからGo Modulesへの移行に関する情報: Go言語の公式ブログや関連する技術記事。