[インデックス 16188] ファイルの概要
コミット
- コミットハッシュ:
a9c695204db90e21c798edabfc7aea9316a347ba - 作者: Rob Pike r@golang.org
- コミット日時: 2013年4月16日 14:20:06 -0700
GitHub上でのコミットページへのリンク
https://github.com/golang/go/commit/a9c695204db90e21c798edabfc7aea9316a347ba
元コミット内容
doc: more doubled words
I wrote a tool.
R=golang-dev, bradfitz
CC=golang-dev
https://golang.org/cl/8695047
変更の背景
このコミットは、Goプロジェクトのドキュメント内に存在する重複した単語（"doubled words"）を修正することを目的としています。コミットメッセージには「I wrote a tool.」とあり、Rob Pike氏が重複単語を検出・修正するためのツールを作成し、それを用いてドキュメントの品質向上を図ったことが示唆されます。このような修正は、ドキュメントの可読性を高め、プロフェッショナルな印象を維持するために重要です。特に技術ドキュメントにおいては、正確性と簡潔さが求められるため、些細な重複表現も排除することが望ましいとされます。
前提知識の解説
重複単語 (Doubled Words)
「重複単語」とは、文章中に同じ単語が連続して出現する文法的な誤りの一種です。例えば、「the the」、「and and」、「to to」などがこれに該当します。このような重複は、タイピングミス、コピー＆ペーストの誤り、あるいは単に注意不足によって発生することがあります。文章の読みやすさを著しく損ない、プロフェッショナルな印象を損なうため、校正の段階で修正されるべき点とされています。
DejaGNU
DejaGNUは、GNUプロジェクトが開発したテストフレームワークです。主にコンパイラ、リンカ、デバッガなどのツールチェインのテストに使用されます。テストスクリプトはTcl言語で記述され、テスト対象のプログラムを実行し、その出力が期待される結果と一致するかどうかを検証します。Go言語のgccgo（GCCベースのGoコンパイラ）のテストスイートでも利用されており、gcc/testsuite/go.test/go-test.expというパスにそのスクリプトが存在することが、変更されたドキュメントから読み取れます。
技術的詳細
このコミットは、Goプロジェクトの公式ドキュメントであるdoc/gccgo_contribute.htmlとdoc/install.htmlの2つのHTMLファイルを対象としています。変更内容は、それぞれのファイル内で重複していた単語を削除するという非常にシンプルなものです。
具体的には、以下の重複が修正されました。
doc/gccgo_contribute.html内の「found in in」という表現から2つ目の「in」を削除。doc/install.html内の「to to」という表現から2つ目の「to」を削除。
Rob Pike氏が「I wrote a tool.」と述べていることから、手動での修正ではなく、自動化されたツール（おそらくGo言語で書かれたもの）を用いてこれらの重複を検出し、修正したと考えられます。このようなツールは、大規模なドキュメントセットやコードベースにおいて、一貫した品質を維持するために非常に有効です。ツールの導入により、ヒューマンエラーを減らし、校正プロセスを効率化することができます。
コアとなるコードの変更箇所
このコミットによって変更されたファイルと行は以下の通りです。
diff --git a/doc/gccgo_contribute.html b/doc/gccgo_contribute.html
index 4d268e02c5..b2a0b651cc 100644
--- a/doc/gccgo_contribute.html
+++ b/doc/gccgo_contribute.html
@@ -84,7 +84,7 @@ To run the gccgo test suite, run <code>make check-go</code> in your
build directory. This will run various tests
under <code>gcc/testsuite/go.*</code> and will also run
the <code>libgo</code> testsuite. This copy of the tests from the
-main Go repository is run using the DejaGNU script found in
+main Go repository is run using the DejaGNU script found
in <code>gcc/testsuite/go.test/go-test.exp</code>.
</p>
diff --git a/doc/install.html b/doc/install.html
index f2e21b4416..b667819429 100644
--- a/doc/install.html
+++ b/doc/install.html
@@ -166,7 +166,7 @@ the <code>GOROOT</code> environment variable to your chosen path.\n </p>\n \n <p>\n-Add the <code>bin</code> subdirectory of your Go root (for example, <code>c:\\Go\\bin</code>) to to your <code>PATH</code> environment variable.\n+Add the <code>bin</code> subdirectory of your Go root (for example, <code>c:\\Go\\bin</code>) to your <code>PATH</code> environment variable.\n </p>\n \n <h4 id=\"windows_msi\">MSI installer (experimental)</h4>\n```
## コアとなるコードの解説
### `doc/gccgo_contribute.html`
このファイルは、`gccgo`への貢献方法について説明しているドキュメントです。変更された行は、`DejaGNU`スクリプトの場所を説明している箇所です。
- **変更前**: `main Go repository is run using the DejaGNU script found in in <code>gcc/testsuite/go.test/go-test.exp</code>.`
- **変更後**: `main Go repository is run using the DejaGNU script found in <code>gcc/testsuite/go.test/go-test.exp</code>.`
「in in」という重複が「in」に修正されました。これにより、文章が自然になり、読みやすさが向上しています。
### `doc/install.html`
このファイルは、Goのインストール方法について説明しているドキュメントです。変更された行は、`PATH`環境変数にGoの`bin`ディレクトリを追加する方法を説明している箇所です。
- **変更前**: `Add the <code>bin</code> subdirectory of your Go root (for example, <code>c:\\Go\\bin</code>) to to your <code>PATH</code> environment variable.`
- **変更後**: `Add the <code>bin</code> subdirectory of your Go root (for example, <code>c:\\Go\\bin</code>) to your <code>PATH</code> environment variable.`
「to to」という重複が「to」に修正されました。これも同様に、文章の可読性を高めるための修正です。
これらの変更は、ドキュメントの品質を維持し、ユーザーが正確な情報をスムーズに理解できるようにするための、細かではあるが重要な改善です。
## 関連リンク
- **Go CL (Code Review)**: [https://golang.org/cl/8695047](https://golang.org/cl/8695047)
## 参考にした情報源リンク
- (特になし。コミット内容と一般的な知識に基づいています。)