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

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

このコミットは、Go言語のツールチェインにおけるコマンド名の参照を統一し、古いツール名から新しい標準的な形式へと変更するものです。具体的には、6covやgotestといったアーキテクチャ固有のツール名や、Goの初期に存在したテストランナーの名称を、go tool covやgo testといった、goコマンドのサブコマンド形式に書き換えています。これにより、Goツールの利用方法がより一貫性のあるものとなり、ユーザーエクスペリエンスが向上しました。

コミット

commit d6f8c751deaeab8ce173a230aa5160b52407560f
Author: Rob Pike <r@golang.org>
Date:   Mon Feb 20 13:42:37 2012 +1100

    all: rewrite references to old tool names
    
    R=golang-dev, nigeltao
    CC=golang-dev
    https://golang.org/cl/5683045

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

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

元コミット内容

--- a/src/cmd/cov/doc.go
+++ b/src/cmd/cov/doc.go
@@ -11,7 +11,7 @@ sections of code have been executed.  When the command finishes,
 cov prints the line numbers of sections of code in the binary that
 were not executed.   With no arguments it assumes the command "6.out".
 
-Usage: cov [-lsv] [-g substring] [-m minlines] [6.out args]
+Usage: go tool cov [-lsv] [-g substring] [-m minlines] [6.out args]
 
 The options are:
 
@@ -26,8 +26,7 @@ The options are:
 	-m minlines
 	onl y report uncovered sections of code larger than minlines lines
 
-For reasons of disambiguation it is installed as 6cov although it also serves
-as an 8cov and a 5cov.
+The program is the same for all architectures: 386, amd64, and arm.
 
 */
 package documentation
diff --git a/src/pkg/go/doc/testdata/benchmark.go b/src/pkg/go/doc/testdata/benchmark.go
index 0bf567b7c4..0aded5bb4c 100644
--- a/src/pkg/go/doc/testdata/benchmark.go
+++ b/src/pkg/go/doc/testdata/benchmark.go
@@ -16,7 +16,7 @@ var matchBenchmarks = flag.String("test.bench", "", "regular expression to selec
 var benchTime = flag.Float64("test.benchtime", 1, "approximate run time for each benchmark, in seconds")
 
 // An internal type but exported because it is cross-package; part of the implementation
-// of gotest.
+// of go test.
 type InternalBenchmark struct {
 	Name string
 	F    func(b *B)
@@ -213,7 +213,7 @@ func (r BenchmarkResult) String() string {
 }
 
 // An internal function but exported because it is cross-package; part of the implementation
-// of gotest.
+// of go test.
 func RunBenchmarks(matchString func(pat, str string) (bool, error), benchmarks []InternalBenchmark) {
 	// If no flag was specified, don't run benchmarks.
 	if len(*matchBenchmarks) == 0 {
@@ -281,7 +281,7 @@ func (b *B) trimOutput() {
 }
 
 // Benchmark benchmarks a single function. Useful for creating
-// custom benchmarks that do not use gotest.
+// custom benchmarks that do not use go test.
 func Benchmark(f func(b *B)) BenchmarkResult {
 	b := &B{
 		common: common{
diff --git a/src/pkg/go/doc/testdata/testing.go b/src/pkg/go/doc/testdata/testing.go
index cfe212dc1d..71c1d1eaf0 100644
--- a/src/pkg/go/doc/testdata/testing.go
+++ b/src/pkg/go/doc/testdata/testing.go
@@ -3,7 +3,7 @@
 // license that can be found in the LICENSE file.
 
 // Package testing provides support for automated testing of Go packages.
-// It is intended to be used in concert with the ``gotest'' utility, which automates
+// It is intended to be used in concert with the ``go test'' utility, which automates
 // execution of any function of the form
 //     func TestXxx(*testing.T)
 // where Xxx can be any alphanumeric string (but the first letter must not be in
@@ -12,7 +12,7 @@
 //
 // Functions of the form
 //     func BenchmarkXxx(*testing.B)
-// are considered benchmarks, and are executed by gotest when the -test.bench
+// are considered benchmarks, and are executed by go test when the -test.bench
 // flag is provided.
 //
 // A sample benchmark function looks like this:
@@ -53,7 +53,7 @@ var (
 	// The short flag requests that tests run more quickly, but its functionality
 	// is provided by test writers themselves.  The testing package is just its
 	// home.  The all.bash installation script sets it to make installation more
-\t// efficient, but by default the flag is off so a plain "gotest" will do a
+\t// efficient, but by default the flag is off so a plain "go test" will do a
 \t// full test of the package.
 \tshort = flag.Bool("test.short", false, "run smaller test suite to save time")
 
@@ -205,7 +205,7 @@ func (t *T) Parallel() {
 }
 
 // An internal type but exported because it is cross-package; part of the implementation
-// of gotest.
+// of go test.
 type InternalTest struct {
 	Name string
 	F    func(*T)
@@ -227,7 +227,7 @@ func tRunner(t *T, test *InternalTest) {
 }
 
 // An internal function but exported because it is cross-package; part of the implementation
-// of gotest.
+// of go test.
 func Main(matchString func(pat, str string) (bool, error), tests []InternalTest, benchmarks []InternalBenchmark, examples []InternalExample) {
 	flag.Parse()
 	parseCpuList()

変更の背景

Go言語の初期のツールチェインでは、コンパイラやリンカなどのツールがターゲットアーキテクチャ（例: 386、amd64、arm）に応じて異なる名前（例: 6g、8g、5g）を持っていました。これに伴い、コードカバレッジツールも6cov、8cov、5covといった形でアーキテクチャ固有の名前で提供されていました。また、テスト実行ツールもgotestという独立したコマンドとして存在していました。

しかし、Go言語が成熟するにつれて、これらのアーキテクチャ固有の命名規則や、独立したツールコマンドは、ユーザーにとって混乱を招く可能性がありました。特に、goコマンドが導入され、ビルド、テスト、フォーマットなど、Go開発における主要な操作を一元的に管理するようになったことで、個別のツール名を直接参照するのではなく、goコマンドのサブコマンドとしてツールを呼び出す形式が推奨されるようになりました。

このコミットは、このような背景のもと、Goツールチェインの統一性と使いやすさを向上させるために行われました。ドキュメントやテストコード内の古いツール名への参照を更新し、go tool <toolname>やgo <subcommand>といった新しい標準的な呼び出し方に合わせることで、Go開発者がより直感的かつ一貫した方法でツールを利用できるようにすることが目的です。

前提知識の解説

Go言語のツールチェイン

Go言語は、コンパイラ、リンカ、アセンブラ、フォーマッタ、テストランナーなど、開発に必要な一連のツールを標準で提供しています。これらを総称して「Goツールチェイン」と呼びます。

go コマンド

goコマンドは、Goツールチェインの中心となるコマンドラインインターフェースです。go build、go run、go test、go fmtなど、様々なサブコマンドを通じてGoプロジェクトのビルド、実行、テスト、フォーマットなどを行います。

go tool コマンド

go toolコマンドは、goコマンドのサブコマンドの一つで、Goツールチェインに含まれる低レベルなツールや、あまり頻繁には使われないツールを実行するために使用されます。例えば、アセンブラ (go tool asm) や、プロファイリングツール (go tool pprof) などがこれに該当します。このコミットで変更されたcov（カバレッジツール）も、このgo toolの配下に位置づけられることになります。

go test コマンド

go testコマンドは、Goパッケージのテストを実行するための標準的なコマンドです。Goのソースコード内に記述されたTestXxx関数やBenchmarkXxx関数を自動的に検出し、実行します。このコミット以前はgotestという独立したコマンドが存在していましたが、この変更によりgo testに統合されました。

アーキテクチャ固有のツール名（旧来）

Go言語の初期には、異なるCPUアーキテクチャ（例: 386、amd64、arm）に対応するために、コンパイラやアセンブラなどのツールがアーキテクチャを示す数字をプレフィックスとして持つことがありました。例えば、386アーキテクチャ向けのコンパイラは6g、amd64向けは8g、arm向けは5gといった具合です。これに伴い、カバレッジツールも6cov、8cov、5covのように呼ばれていました。この命名規則は、Goがクロスコンパイルを強く意識していることの表れでもありましたが、ユーザーにとっては冗長であり、goコマンドによる統一的なインターフェースの登場により、その必要性は薄れていきました。

技術的詳細

このコミットの技術的な変更は、主にGoのドキュメント、テストデータ、および内部的なコードコメントにおける文字列の置換に集約されます。

  1. src/cmd/cov/doc.go の変更:

    • Usage: cov ... が Usage: go tool cov ... に変更されました。これは、カバレッジツールcovが、go toolコマンドのサブコマンドとして呼び出されるようになったことを明示しています。
    • For reasons of disambiguation it is installed as 6cov although it also serves as an 8cov and a 5cov. という記述が削除されました。これは、6cov、8cov、5covといったアーキテクチャ固有のツール名が廃止され、go tool covという単一のコマンドで全てのアーキテクチャに対応するようになったことを示しています。代わりに The program is the same for all architectures: 386, amd64, and arm. という説明が追加され、この統一されたアプローチを強調しています。

  2. src/pkg/go/doc/testdata/benchmark.go および src/pkg/go/doc/testdata/testing.go の変更:

    • これらのファイルでは、gotestという文字列が全てgo testに置換されています。これは、Goのテスト実行ツールが、独立したgotestコマンドから、goコマンドのサブコマンドであるgo testに完全に移行したことを反映しています。特に、testingパッケージのドキュメントにおいて、テストやベンチマークの実行がgo testユーティリティと連携して行われることが明確に記述されるようになりました。

これらの変更は、Goツールチェインの設計思想が、初期のアーキテクチャ固有のツール群から、goコマンドを中心とした統一的で抽象化されたインターフェースへと進化していることを示しています。これにより、ユーザーは使用しているアーキテクチャを意識することなく、一貫したコマンドでGoのツールを利用できるようになります。

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

このコミットは、Goのツールチェインの動作そのものを変更するものではなく、主にドキュメントやテストコード内のツール名への参照を更新するものです。したがって、「コアとなるコード」という観点では、Goのコンパイラやランタイムのロジックに直接的な変更はありません。

変更が加えられたファイルは以下の通りです。

  • src/cmd/cov/doc.go: covツールの使用方法に関するドキュメントファイル。
  • src/pkg/go/doc/testdata/benchmark.go: ベンチマーク機能のテストデータおよび関連ドキュメント。
  • src/pkg/go/doc/testdata/testing.go: テスト機能のテストデータおよび関連ドキュメント。

これらのファイルは、Goのツールやパッケージの振る舞いを説明するドキュメントや、そのドキュメントが正しく機能するかを確認するためのテストデータの一部であり、Goツールチェインのユーザーインターフェースとドキュメンテーションの整合性を保つ上で重要な役割を果たします。

コアとなるコードの解説

このコミットにおける「コアとなるコード」は、Goのツールチェインのドキュメントとテストデータ内の文字列です。これらの変更は、Goのコマンドラインインターフェースの進化を反映しており、ユーザーがGoツールをどのように利用すべきかを示す規範となります。

src/cmd/cov/doc.go の変更点

  • Usage: cov から Usage: go tool cov への変更: これは、covツールが独立した実行ファイルとしてではなく、go toolコマンドのサブコマンドとして呼び出されることを明確に示しています。これにより、Goの全ての公式ツールがgoコマンドの下に統合され、発見しやすさと一貫性が向上します。
  • アーキテクチャ固有のツール名に関する記述の削除と追加: 旧来の6cov、8cov、5covといったアーキテクチャ固有のツール名に関する説明が削除され、代わりに「プログラムは全てのアーキテクチャ（386, amd64, arm）で同じである」という記述が追加されました。これは、Goのツールチェインがクロスプラットフォーム対応を強化し、単一のバイナリで複数のアーキテクチャをサポートするようになったことを示唆しています。ユーザーはもはや、ターゲットアーキテクチャに応じて異なるツール名を使い分ける必要がなくなりました。

src/pkg/go/doc/testdata/benchmark.go および src/pkg/go/doc/testdata/testing.go の変更点

  • gotest から go test への変更: これらのファイルでは、gotestという文字列が全てgo testに置き換えられています。これは、Goのテスト実行機能が、初期のgotestという独立したコマンドから、goコマンドの主要なサブコマンドであるgo testに完全に統合されたことを意味します。go testは、Goのビルドシステムと密接に連携し、テストの発見、コンパイル、実行、結果の報告までを一貫して行います。この変更により、Goのテストフレームワークの利用方法が標準化され、より多くのGo開発者にとって直感的になりました。

これらの変更は、Go言語の設計哲学である「シンプルさ」と「一貫性」を追求する一環として行われました。ユーザーがGoツールをより簡単に、そして迷うことなく利用できるようにするための重要なステップと言えます。

関連リンク

参考にした情報源リンク