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

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

このコミットは、Go言語のソースからのインストール手順に関するドキュメント、具体的にはdoc/install-source.htmlファイル内のMercurialのインストール手順を更新するものです。以前の、特定のOS（Ubuntu/Debian）やツール（easy_install, apt-get）に依存したMercurialのインストール指示を削除し、より汎用的な「Mercurialの公式ダウンロードページを参照する」という指示に置き換えています。

コミット

commit 0e596024c203b27e4940fba0844a58f4e3abc989
Author: Andrew Gerrand <adg@golang.org>
Date:   Sat Apr 14 13:27:11 2012 +1000

    doc: update Mercurial installation instructions
    
    R=r
    CC=golang-dev
    https://golang.org/cl/6031046

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

https://github.com/golang/go/commit/0e596024c203b27e4940fba0844a58f4e3abc989

元コミット内容

doc: update Mercurial installation instructions

R=r
CC=golang-dev
https://golang.org/cl/6031046

変更の背景

この変更の背景には、ドキュメントの保守性と正確性の向上が挙げられます。以前のMercurialのインストール手順は、特定のOSディストリビューション（Ubuntu/Debian）やPythonのパッケージ管理ツール（easy_install）に特化しており、時間の経過とともに陳腐化したり、環境によっては機能しなくなる可能性がありました。特に、Mercurialのバージョン指定（mercurial==2.0）や、Ubuntu/Debianにおけるパッケージの古さに関する注意書きは、常に最新の状態を保つのが困難です。

Go言語のインストール手順は、Mercurialがシステムにインストールされていることを前提としていますが、その具体的なインストール方法はMercurialプロジェクト自身が最も正確かつ最新の情報を提供できるはずです。そのため、GoのドキュメントがMercurialのインストール方法の詳細を抱え込むのではなく、公式のダウンロードページに誘導することで、GoのドキュメントはGo自身のインストールに集中し、Mercurialのインストールに関する責任をMercurialプロジェクトに委ねることができます。これにより、ドキュメントのメンテナンスコストが削減され、ユーザーは常に最新かつ正確なMercurialのインストール手順にアクセスできるようになります。

前提知識の解説

  • Go言語 (Golang): Googleによって開発されたオープンソースのプログラミング言語です。シンプルさ、効率性、並行処理のサポートが特徴で、システムプログラミングからWebアプリケーション開発まで幅広く利用されています。Goのソースコードからビルドしてインストールする場合、特定のバージョン管理システム（かつてはMercurial、現在はGitが主流）が必要となることがあります。
  • Mercurial (Hg): Gitと同様に分散型バージョン管理システム（DVCS）の一つです。かつてはGo言語のソースコード管理に利用されていましたが、後にGitに移行しました。このコミットが作成された2012年時点では、Goのソースコードを取得するためにMercurialが必要でした。
  • easy_install: Pythonのパッケージ管理ツールの一つで、Pythonパッケージをインストールするために使用されました。しかし、現在はより高機能で広く使われているpipに置き換えられています。
  • apt-get: Debian系Linuxディストリビューション（Ubuntuなど）で利用されるパッケージ管理コマンドです。ソフトウェアパッケージのインストール、アップグレード、削除などを行います。
  • sudo: Unix系OSにおいて、一般ユーザーがスーパーユーザー（root）の権限でコマンドを実行するためのコマンドです。システム設定の変更やソフトウェアのインストールなど、特権が必要な操作に用いられます。
  • python-setuptools: Pythonパッケージのビルド、配布、インストールのためのライブラリです。easy_installはこの一部として提供されていました。
  • python-dev: PythonのC拡張モジュールをコンパイルするために必要なヘッダーファイルやライブラリを提供するパッケージです。
  • build-essential: Debian系Linuxディストリビューションにおけるメタパッケージで、C/C++コンパイラ（GCCなど）やmakeツールなど、ソフトウェアのコンパイルに必要な基本的なツール群を含んでいます。
  • HTML (HyperText Markup Language): Webページの構造を定義するためのマークアップ言語です。このコミットでは、Goのインストール手順が記述されたHTMLファイルを変更しています。

技術的詳細

このコミットは、doc/install-source.htmlというHTMLドキュメントの変更に焦点を当てています。変更の核心は、Mercurialのインストールに関する具体的なコマンドライン指示を削除し、代わりにMercurialの公式ダウンロードページへのリンクを提示することです。

具体的に削除されたのは以下の部分です。

  1. sudo easy_install mercurial==2.0: これはPythonのeasy_installツールを使ってMercurialのバージョン2.0をインストールするコマンドです。easy_installはPythonの古いパッケージ管理ツールであり、特定のバージョンを固定してインストールする指示は、環境によっては依存関係の問題を引き起こしたり、ツールの非推奨化によって機能しなくなる可能性があります。
  2. Ubuntu/Debianユーザー向けの注意書きとコマンド: 
    <p>
On Ubuntu/Debian, the Mercurial in your distribution's
package repository is most likely old and broken.
You might try this first:
</p>

<pre>apt-get install python-setuptools python-dev build-essential</pre>
    この部分は、Ubuntu/Debianの公式リポジトリにあるMercurialが古いまたは問題がある可能性を指摘し、apt-getを使って関連するビルドツールをインストールするよう促していました。しかし、OSのバージョンアップやMercurial自体のリリースサイクルにより、この情報がすぐに古くなるリスクがありました。また、apt-getコマンド自体も、ユーザーのシステム環境（例えば、sudo権限の有無や、既にこれらのパッケージがインストールされているかなど）に依存するため、一概に推奨できるものではありません。

これらの具体的な指示を削除し、以下の汎用的な指示に置き換えることで、ドキュメントの堅牢性と将来性が向上しています。

<p>
If you do not have a working Mercurial installation,
follow the instructions on the
<a href="http://mercurial.selenic.com/downloads/">Mercurial downloads</a> page.
</p>

この変更は、ドキュメントが特定の環境やツールの詳細なインストール手順を維持する負担を軽減し、その責任を各ソフトウェアの公式ドキュメントに委ねるという、一般的なドキュメンテーションのベストプラクティスに沿ったものです。これにより、Goのインストール手順はより簡潔になり、Mercurialのインストールに関する最新かつ正確な情報は常にMercurialの公式ソースから得られるようになります。

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

変更はdoc/install-source.htmlファイルのみで行われています。

--- a/doc/install-source.html
+++ b/doc/install-source.html
@@ -106,26 +106,13 @@ On Windows, install <code>gcc</code> with
 
 <p>
 To perform the next step you must have Mercurial installed. (Check that you
-have an <code>hg</code> command.) This suffices to install Mercurial on most
-Unix systems:
+have an <code>hg</code> command.)
 </p>
 
-<pre>
-sudo easy_install mercurial==2.0
-</pre>
-
-<p>
-On Ubuntu/Debian, the Mercurial in your distribution's
-package repository is most likely old and broken.
-You might try this first:
-</p>
-
-<pre>apt-get install python-setuptools python-dev build-essential</pre>
-
 <p>
-If that fails, or if you use Windows, install manually from the
-<a href="http://mercurial.selenic.com/wiki/Download">Mercurial Download</a>
-page.
+If you do not have a working Mercurial installation,
+follow the instructions on the
+<a href="http://mercurial.selenic.com/downloads/">Mercurial downloads</a> page.
 </p>
 
 <p>

コアとなるコードの解説

この変更は、HTMLドキュメント内のMercurialインストールに関するセクションを簡素化しています。

  • 削除された部分:

    • sudo easy_install mercurial==2.0 というコマンドブロック。これはPythonのeasy_installを使ったMercurialの特定のバージョン（2.0）のインストール指示でした。
    • Ubuntu/Debianユーザー向けの、ディストリビューションのMercurialが古い可能性と、apt-get install python-setuptools python-dev build-essentialというコマンドを試すよう促す段落とコマンドブロック。
    • Windowsユーザーや上記コマンドが失敗した場合にMercurialのWikiのダウンロードページを参照するよう促す段落。

  • 追加された部分:

    • If you do not have a working Mercurial installation, follow the instructions on the <a href="http://mercurial.selenic.com/downloads/">Mercurial downloads</a> page. という新しい段落。これは、Mercurialがインストールされていない場合に、Mercurialの公式ダウンロードページに直接誘導するものです。

この変更により、Goのインストール手順ドキュメントは、Mercurialのインストールに関する詳細な手順を自身で維持するのではなく、Mercurialの公式ソースにその責任を委譲する形になりました。これにより、ドキュメントのメンテナンスが容易になり、ユーザーは常にMercurialの最新かつ正確なインストール手順を参照できるようになります。

関連リンク

参考にした情報源リンク