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

このコミットは、Go言語の公式ドキュメントである doc/go1.1.html ファイルに対する更新です。主な目的は、os/signal パッケージに新しく追加された Stop 関数に関するドキュメントを追加すること、およびドキュメント内の項目リストのソート順を修正することです。具体的には、image/jpeg パッケージに関する記述と unicode パッケージに関する記述の順序が調整され、os/signal.Stop の説明が適切な位置に挿入されています。

コミット

コミットハッシュ: e0f338cca5085dd860358eb8c2091de335e6a13a
作者: Rob Pike r@golang.org
コミット日時: 2013年4月3日水曜日 10:59:36 -0700

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

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

元コミット内容

doc/go1.1.html: document os/signal.Stop
Also fix the sort order of the laundry list.

R=golang-dev, bradfitz
CC=golang-dev
https://golang.org/cl/8325044

os/signal.Stop のドキュメント追加:
- os/signal パッケージに新しく追加された Stop 関数に関する <li> エントリが、適切なセクション（おそらく「Minor changes to the standard library」のようなセクション）に追加されました。
- このエントリは、Stop 関数がチャネルへのシグナル配信を停止する機能を持つことを明確に記述しています。
リストのソート順修正:
- 既存の image/jpeg パッケージに関する記述が、ドキュメント内のより適切な位置（おそらくアルファベット順または関連性のあるセクション）に移動されました。元の位置から削除され、新しい位置に挿入されています。
- 同様に、unicode/utf8 パッケージの ValidRune 関数に関する記述と、unicode パッケージのUnicodeバージョン更新に関する記述の順序が入れ替えられました。これは、リスト内の項目が論理的またはアルファベット順に並ぶようにするための調整と考えられます。

これらの変更は、Go 1.1のリリースノートの正確性、完全性、および可読性を向上させることを目的としています。

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

--- a/doc/go1.1.html
+++ b/doc/go1.1.html
@@ -749,6 +749,11 @@ The undocumented and only partially implemented \"noescape\" feature of the
 package has been removed; programs that depend on it will break.\n </li>\n \n+<li>\n+The <a href=\"/pkg/image/jpeg/\"><code>image/jpeg</code></a> package now\n+reads progressive JPEG files and handles a few more subsampling configurations.\n+</li>\n+\n <li>\n The <a href=\"/pkg/io/\"><code>io</code></a> package now exports the\n <a href=\"/pkg/io/#ByteWriter\"><code>io.ByteWriter</code></a> interface to capture the common\n@@ -901,8 +906,9 @@ The new method <a href=\"/pkg/os/#FileMode.IsRegular\"><code>os.FileMode.IsRegular\n </li>\n \n <li>\n-The <a href=\"/pkg/image/jpeg/\"><code>image/jpeg</code></a> package now\n-reads progressive JPEG files and handles a few more subsampling configurations.\n+The <a href=\"/pkg/os/signal/\"><code>os/signal</code></a> package has a new function,\n+<a href=\"/pkg/os/signal/#Stop\"><code>Stop</code></a>, which stops the package delivering\n+any further signals to the channel.\n </li>\n \n <li>\n@@ -975,7 +981,6 @@ In the <a href=\"/pkg/text/template/\"><code>text/template</code></a>\n and\n <a href=\"/pkg/html/template/\"><code>html/template</code></a> packages,\n templates can now use parentheses to group the elements of pipelines, simplifying the construction of complex pipelines.\n-TODO: Link to example.\n Also, as part of the new parser, the\n <a href=\"/pkg/text/template/parse/#Node\"><code>Node</code></a> interface got two new methods to provide\n better error reporting.\n@@ -989,12 +994,12 @@ packages and there are safeguards to guarantee that.\n </li>\n \n <li>\n-In the <a href=\"/pkg/unicode/utf8/\"><code>unicode/utf8</code></a> package,\n-the new function <a href=\"/pkg/unicode/utf8/#ValidRune\"><code>ValidRune</code></a> reports whether the rune is a valid Unicode code point.\n-To be valid, a rune must be in range and not be a surrogate half.\n+The implementation of the <a href=\"/pkg/unicode/\"><code>unicode</code></a> package has been updated to Unicode version 6.2.0.\n </li>\n \n <li>\n-The implementation of the <a href=\"/pkg/unicode/\"><code>unicode</code></a> package has been updated to Unicode version 6.2.0.\n+In the <a href=\"/pkg/unicode/utf8/\"><code>unicode/utf8</code></a> package,\n+the new function <a href=\"/pkg/unicode/utf8/#ValidRune\"><code>ValidRune</code></a> reports whether the rune is a valid Unicode code point.\n+To be valid, a rune must be in range and not be a surrogate half.\n </li>\n </ul>\n```

## コアとなるコードの解説

上記の差分は、`doc/go1.1.html` ファイルに対する具体的な変更を示しています。

1.  **`image/jpeg` の移動**:
    *   `-` で始まる行 (`-The <a href="/pkg/image/jpeg/"><code>image/jpeg</code></a> package now...`) は、元の位置（約901行目）から `image/jpeg` パッケージに関する記述が削除されたことを示します。
    *   `+` で始まる行 (`+The <a href="/pkg/image/jpeg/"><code>image/jpeg</code></a> package now...`) は、同じ記述が新しい位置（約749行目）に挿入されたことを示します。これにより、リスト内の項目の順序が変更されました。

2.  **`os/signal.Stop` の追加**:
    *   約906行目付近に、`os/signal` パッケージの `Stop` 関数に関する新しい `<li>` エントリが追加されています。
    *   このエントリは、「`os/signal` パッケージには新しい関数 `Stop` があり、これはチャネルへのシグナル配信を停止します」という内容を記述しており、`Stop` 関数の目的を簡潔に説明しています。

3.  **`unicode` 関連の順序修正**:
    *   約989行目付近で、`unicode/utf8` パッケージの `ValidRune` 関数に関する記述と、`unicode` パッケージのUnicodeバージョン更新に関する記述の順序が入れ替えられています。
    *   元の順序では `unicode/utf8` が先でしたが、変更後は `unicode` パッケージの更新が先に記述され、その後に `unicode/utf8.ValidRune` が続く形になっています。これは、関連する項目をより論理的な順序に並べ替えるための調整です。

これらの変更はすべて、Go 1.1のリリースノートの正確性、完全性、およびユーザーが情報を探しやすくするための改善に貢献しています。

## 関連リンク

*   Go 1.1 Release Notes (公式): [https://go.dev/doc/go1.1](https://go.dev/doc/go1.1) (このコミットが変更しているドキュメントの最終版)
*   `os/signal` パッケージのドキュメント: [https://pkg.go.dev/os/signal](https://pkg.go.dev/os/signal)
*   `image/jpeg` パッケージのドキュメント: [https://pkg.go.dev/image/jpeg](https://pkg.go.dev/image/jpeg)
*   `unicode` パッケージのドキュメント: [https://pkg.go.dev/unicode](https://pkg.go.dev/unicode)
*   `unicode/utf8` パッケージのドキュメント: [https://pkg.go.dev/unicode/utf8](https://pkg.go.dev/unicode/utf8)

## 参考にした情報源リンク

*   GitHubコミットページ: [https://github.com/golang/go/commit/e0f338cca5085dd860358eb8c2091de335e6a13a](https://github.com/golang/go/commit/e0f338cca5085dd860358eb8c2091de335e6a13a)
*   Go CL 8325044: [https://golang.org/cl/8325044](https://golang.org/cl/8325044) (Gerrit Code Review へのリンク、コミットメッセージに記載)
*   Go言語公式ドキュメント (Go 1.1): [https://go.dev/doc/go1.1](https://go.dev/doc/go1.1) (変更内容の確認のため)
*   Go言語の `os/signal` パッケージに関する一般的な知識
*   Go言語のドキュメンテーション慣習に関する一般的な知識

comemo

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

コミット

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

元コミット内容

変更の背景

前提知識の解説

Go言語のリリースノート (`doc/go1.1.html`)

`os/signal` パッケージ

`os/signal.Notify` 関数

`os/signal.Stop` 関数

`image/jpeg` パッケージ

`unicode` および `unicode/utf8` パッケージ

技術的詳細

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

Keyboard shortcuts

comemo