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

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

このコミットは、Go言語のコマンドラインツール go のドキュメントを更新し、main が予約されたインポートパスであることを明記するものです。具体的には、src/cmd/go/doc.go と src/cmd/go/help.go の2つのファイルが変更され、all および std と並んで main が特別な意味を持つインポートパスとして追加されました。

コミット

commit 29b4de25b31c1b539017da43683012d986547bc1
Author: Rob Pike <r@golang.org>
Date:   Mon Sep 16 22:53:12 2013 +1000

    cmd/go: document that "main" is a reserved import path
    Fixes #6312.
    
    R=golang-dev, dave
    CC=golang-dev
    https://golang.org/cl/13391049

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

https://github.com/golang/go/commit/29b4de25b31c1b539017da43683012d986547bc1

元コミット内容

このコミットは、cmd/go ディレクトリ内のドキュメントを更新し、"main" が予約されたインポートパスであることを明記しています。これはIssue #6312を修正するものです。

変更されたファイルは以下の通りです。

  • src/cmd/go/doc.go
  • src/cmd/go/help.go

両ファイルにおいて、"all" と "std" という特別なインポートパスの説明に加えて、"- "main" denotes the top-level package in a stand-alone executable." という記述が追加されています。これにより、go ツールでビルドされるパッケージには使用すべきではない予約名として "main" が明確に示されました。

変更の背景

この変更の背景には、Go言語のパッケージ管理とビルドシステムにおける main パッケージの特殊性があります。Goでは、実行可能ファイルをビルドする際にエントリポイントとなるパッケージを main と命名し、その中に main 関数を定義します。しかし、この main という名前が、通常のライブラリパッケージのようにインポートパスとして使用されると、Goツールチェーンの動作に混乱を招く可能性がありました。

Issue #6312（"cmd/go: document that "main" is a reserved import path"）は、この曖昧さを解消し、main が通常のインポートパスとして使用されるべきではないことを公式ドキュメントに明記する必要があるという認識から提起されました。これにより、開発者が誤って main をインポートパスとして使用し、予期せぬビルドエラーや動作に遭遇するのを防ぐことが目的です。

"all" や "std" といった既存の予約語と同様に、"main" もGoツールが内部的に特別な意味を持つキーワードとして扱っているため、ユーザーがこれらを通常のパッケージ名として使用することは推奨されません。このコミットは、その事実をドキュメントに反映させることで、Go開発者へのガイダンスを強化しています。

前提知識の解説

このコミットを理解するためには、以下のGo言語に関する前提知識が必要です。

Go言語のパッケージとインポートパス

Go言語では、コードは「パッケージ」という単位で整理されます。各Goファイルは package <パッケージ名> で始まり、同じディレクトリ内のファイルは通常同じパッケージに属します。 パッケージは、他のパッケージから import ステートメントを使って参照されます。import "path/to/package" のように、インポートパスは通常、Goモジュール内のディレクトリ構造や外部リポジトリのURLに対応します。

main パッケージと実行可能ファイル

Goプログラムが実行可能ファイルとしてビルドされるためには、必ず main という名前のパッケージが必要です。この main パッケージには、プログラムのエントリポイントとなる func main() 関数が含まれていなければなりません。go build コマンドは、main パッケージを含むディレクトリをコンパイルし、実行可能ファイルを生成します。

go コマンドとヘルプシステム

go コマンドは、Go言語のビルド、テスト、依存関係管理などを行うための主要なツールです。go help コマンドは、go コマンドの様々なサブコマンドや概念に関するドキュメントを表示します。このドキュメントは、Goソースコード内の doc.go や help.go ファイルに記述されています。

予約されたインポートパス (all, std)

Goツールには、特別な意味を持つ予約されたインポートパスがいくつか存在します。

  • all: go list all のように使用され、GOPATH 内のすべてのパッケージディレクトリを展開します。これは、システム上のすべてのGoパッケージを列挙する際に便利です。
  • std: go list std のように使用され、Go標準ライブラリに含まれるパッケージのみを展開します。

これらの予約語は、通常のパッケージ名として使用されることを意図していません。

Issue Tracking (GitHub Issues)

Goプロジェクトでは、バグ報告や機能改善の提案にGitHub Issuesが使用されます。Fixes #6312 という記述は、このコミットがGitHub上のIssue番号6312を解決したことを示します。

技術的詳細

このコミットの技術的な変更は、Goツールのドキュメント生成に関わる src/cmd/go/doc.go と src/cmd/go/help.go ファイルのテキストコンテンツの修正に限定されます。これらのファイルは、go help コマンドがユーザーに表示する情報を定義しています。

変更前は、これらのファイルには all と std という特別なインポートパスに関する説明のみが含まれていました。

// src/cmd/go/doc.go (変更前の一部)
// The special import path "all" expands to all package directories
// found in all the GOPATH trees.  For example, 'go list all'
// lists all the packages on the local system.
//
// The special import path "std" is like all but expands to just the
// packages in the standard Go library.

このコミットでは、上記のセクションに main が追加され、go ツールでビルドされるパッケージには使用すべきではない予約名として明示されました。

// src/cmd/go/doc.go (変更後の一部)
// There are three reserved names for paths that should not be used
// for packages to be built with the go tool:
//
// - "main" denotes the top-level package in a stand-alone executable.
//
// - "all" expands to all package directories found in all the GOPATH
// trees. For example, 'go list all' lists all the packages on the local
// system.
//
// - "std" is like all but expands to just the packages in the standard
// Go library.

この変更は、Goツールの動作自体を変更するものではなく、その動作に関するユーザー向けの説明を改善するものです。これにより、main パッケージの特殊性がより明確になり、開発者がインポートパスとして main を使用することによる潜在的な問題を回避できるようになります。

このドキュメントの更新は、Goツールのユーザーエクスペリエンスを向上させ、一般的な誤解を防ぐための重要なステップです。

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

このコミットで変更されたコアとなるコードは、Goコマンドのドキュメントを生成するGoソースファイル内のコメントブロックです。

src/cmd/go/doc.go

--- a/src/cmd/go/doc.go
+++ b/src/cmd/go/doc.go
@@ -542,12 +542,17 @@ environment variable (see 'go help gopath').
 If no import paths are given, the action applies to the
 package in the current directory.
 
-The special import path "all" expands to all package directories
-found in all the GOPATH trees.  For example, 'go list all'
-lists all the packages on the local system.
+There are three reserved names for paths that should not be used
+for packages to be built with the go tool:
 
-The special import path "std" is like all but expands to just the
-packages in the standard Go library.
+- "main" denotes the top-level package in a stand-alone executable.
+
+- "all" expands to all package directories found in all the GOPATH
+trees. For example, 'go list all' lists all the packages on the local
+system.
+
+- "std" is like all but expands to just the packages in the standard
+Go library.
 
 An import path is a pattern if it includes one or more "..." wildcards,
 each of which can match any string, including the empty string and

src/cmd/go/help.go

--- a/src/cmd/go/help.go
+++ b/src/cmd/go/help.go
@@ -25,12 +25,17 @@ environment variable (see 'go help gopath').
 If no import paths are given, the action applies to the
 package in the current directory.
 
-The special import path "all" expands to all package directories
-found in all the GOPATH trees.  For example, 'go list all'
-lists all the packages on the local system.
+There are three reserved names for paths that should not be used
+for packages to be built with the go tool:
 
-The special import path "std" is like all but expands to just the
-packages in the standard Go library.
+- "main" denotes the top-level package in a stand-alone executable.
+
+- "all" expands to all package directories found in all the GOPATH
+trees. For example, 'go list all' lists all the packages on the local
+system.
+
+- "std" is like all but expands to just the packages in the standard
+Go library.
 
 An import path is a pattern if it includes one or more "..." wildcards,
 each of which can match any string, including the empty string and

コアとなるコードの解説

上記の変更箇所は、Goコマンドのヘルプメッセージとドキュメントを生成するためのGoソースファイル内のコメントブロックです。Goのツールチェーンは、これらのコメントを解析して、go help コマンドや go doc コマンドで表示されるユーザー向けドキュメントを生成します。

具体的には、以下の点が変更されています。

  1. 導入文の変更:

    • 変更前: "The special import path "all" expands to..."
    • 変更後: "There are three reserved names for paths that should not be used for packages to be built with the go tool:" この変更により、all と std だけでなく、これから説明する名前が「Goツールでビルドされるパッケージには使用すべきではない予約名」であることを明確に示しています。

  2. "main" の追加:

    • 新たに "- "main" denotes the top-level package in a stand-alone executable." という行が追加されました。 これにより、main が単独の実行可能ファイルにおけるトップレベルパッケージを示す特別な名前であり、通常のインポートパスとして使用すべきではないことが明記されました。

  3. リスト形式への変更:

    • 変更前は all と std がそれぞれ独立した段落で説明されていましたが、変更後は3つの予約名が箇条書きのリスト形式で提示されています。これにより、情報の視認性と構造が改善されています。

これらの変更は、Goツールのユーザーが main パッケージの特殊性をより正確に理解し、誤ったインポートパスの使用を避けるための重要なドキュメントの改善です。Goのドキュメントは、Go言語の設計思想の一部であり、このような明確化は開発者の生産性向上に寄与します。

関連リンク

  • Go Issue #6312: https://github.com/golang/go/issues/6312
    • このコミットが修正した元のIssueです。main が予約されたインポートパスであることをドキュメント化する必要性について議論されています。
  • Go Code Review CL 13391049: https://golang.org/cl/13391049
    • このコミットに対応するGoのコードレビューシステム（Gerrit）上の変更リストです。

参考にした情報源リンク

  • 上記のGitHub URLとGo Code Review CLのリンク。
  • Go言語の公式ドキュメント（go help packages や go help gopath など）。
  • Go言語のパッケージとモジュールに関する一般的な知識。