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

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

このコミットは、Go言語の公式ドキュメントであるeffective_go.htmlから、削除されたos.ENOSPCへの参照を削除し、代わりに適切なsyscall.ENOSPCを使用するように修正するものです。また、ファイルを開く操作をos.Openからos.Createに変更しています。これは、Go言語の標準ライブラリの進化に伴うドキュメントの整合性維持を目的としています。

コミット

commit e5102b35f6afaaf5a829768710d15924c126aeeb
Author: Brad Fitzpatrick <bradfitz@golang.org>
Date:   Tue Mar 20 16:50:51 2012 -0700

    doc: remove reference to deleted os.ENOSPC
    
    R=golang-dev, gri, r, r
    CC=golang-dev
    https://golang.org/cl/5866046
---
 doc/effective_go.html | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/effective_go.html b/doc/effective_go.html
index 984533706c..f93a8645d9 100644
--- a/doc/effective_go.html
+++ b/doc/effective_go.html
@@ -2711,11 +2711,11 @@ field for recoverable failures.
 
 <pre>
 for try := 0; try &lt; 2; try++ {\n-    file, err = os.Open(filename)\n+    file, err = os.Create(filename)\n     if err == nil {\n         return\n     }\n-    if e, ok := err.(*os.PathError); ok &amp;&amp; e.Err == os.ENOSPC {\n+    if e, ok := err.(*os.PathError); ok &amp;&amp; e.Err == syscall.ENOSPC {\n         deleteTempFiles()  // Recover some space.\n         continue\n     }\n```

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

[https://github.com/golang/go/commit/e5102b35f6afaaf5a829768710d15924c126aeeb](https://github.com/golang/go/commit/e5102b35f6afaaf5a829768710d15924c126aeeb)

## 元コミット内容

このコミットは、Go言語の公式ドキュメントである`effective_go.html`から、もはや存在しない`os.ENOSPC`への参照を削除することを目的としています。これは、Goの標準ライブラリの変更に合わせてドキュメントを最新の状態に保つための修正です。

## 変更の背景

この変更の背景には、Go言語の標準ライブラリにおけるエラー定数の管理と進化があります。初期のGoのバージョンでは、`os`パッケージ内にファイルシステム関連のエラー定数（例: `os.ENOSPC`）が直接定義されていることがありました。しかし、より汎用的なシステムコールエラーは`syscall`パッケージで定義されるべきであるという設計思想の変更、あるいはリファクタリングにより、`os.ENOSPC`のような定数は`syscall.ENOSPC`に統合または移動されました。

`ENOSPC`は "No space left on device" (デバイスに空き容量がない) というエラーを意味し、ファイルシステム操作でよく発生するエラーです。このエラーを適切にハンドリングするためのコード例が`effective_go.html`に記載されていましたが、参照している定数が古くなったため、ドキュメントのコード例も更新する必要がありました。

また、`os.Open`から`os.Create`への変更も重要です。元のコード例はファイルを「開く」ことを意図していましたが、エラーハンドリングの文脈（特にディスク容量不足からの回復）では、新しいファイルを「作成する」操作の方がより適切で現実的なシナリオを示唆している可能性があります。`os.Create`はファイルが存在しない場合は作成し、存在する場合は切り詰めて開くため、一時ファイルの作成や再試行のシナリオにより合致します。

## 前提知識の解説

*   **Go言語のエラーハンドリング**: Goでは、エラーは多値返却の2番目の戻り値として`error`インターフェース型で返されます。慣例として、エラーがない場合は`nil`が返されます。
*   **`os.PathError`**: `os`パッケージでファイルパスに関連する操作中に発生するエラーを表す構造体です。この構造体は、元のエラー（`Err`フィールド）、操作（`Op`フィールド）、およびファイルパス（`Path`フィールド）を含みます。コード例では、`err.(*os.PathError)`という型アサーションを使って、返されたエラーが`os.PathError`型であるかどうかを確認しています。
*   **`syscall`パッケージ**: Goの標準ライブラリの一部で、オペレーティングシステムのシステムコールへの低レベルなインターフェースを提供します。ファイルシステム操作やネットワーク操作など、OSカーネルと直接やり取りする際に使用される定数や関数が含まれます。`syscall.Errno`型は、システムコールが返すエラー番号を表します。
*   **`ENOSPC`**: "Error No Space" の略で、Unix系システムにおけるエラーコードの一つです。ディスクやパーティションに書き込みのための空き容量がない場合に返されます。Goでは、このエラーは`syscall.ENOSPC`として表現されます。
*   **`os.Open(filename string) (*File, error)`**: 指定された名前のファイルを読み取り専用で開きます。
*   **`os.Create(filename string) (*File, error)`**: 指定された名前のファイルを（存在しない場合は）作成し、読み書きモードで開きます。ファイルが既に存在する場合は、その内容を切り詰めて（サイズを0にして）開きます。

## 技術的詳細

このコミットは、Go言語のドキュメントの正確性を保つための重要な修正です。特に、Goの標準ライブラリが成熟するにつれて、APIの変更やリファクタリングが行われることがあります。`os.ENOSPC`から`syscall.ENOSPC`への変更は、エラー定数のより論理的な配置と、`syscall`パッケージが提供する低レベルなOSエラーとの一貫性を反映しています。

`os.PathError`の`Err`フィールドは、通常、`syscall.Errno`型（またはそれをラップする型）の値を保持します。したがって、`e.Err == syscall.ENOSPC`という比較は、ファイル操作中に発生したOSレベルのエラーがディスク容量不足によるものであるかを正確にチェックする方法です。

`os.Open`から`os.Create`への変更は、単なるタイプミスではなく、コード例の意図をより明確にするためのものです。ディスク容量不足からの回復という文脈では、既存のファイルを読み取る（`os.Open`）よりも、新しいファイルを作成しようとして失敗し、その後スペースを確保して再試行する（`os.Create`）というシナリオの方が自然です。これは、一時ファイルの作成やログファイルの書き込みなど、ディスク容量が問題となる典型的なケースをよりよく表現しています。

この修正は、Goのドキュメントが常に最新かつ正確な情報を提供することの重要性を示しています。開発者が`effective_go.html`を参照する際に、非推奨または削除されたAPIを使用する誤ったガイダンスを受けないようにするために不可欠です。

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

```diff
--- a/doc/effective_go.html
+++ b/doc/effective_go.html
@@ -2711,11 +2711,11 @@ field for recoverable failures.
 
 <pre>
 for try := 0; try &lt; 2; try++ {\n-    file, err = os.Open(filename)\n+    file, err = os.Create(filename)\n     if err == nil {\n         return\n     }\n-    if e, ok := err.(*os.PathError); ok &amp;&amp; e.Err == os.ENOSPC {\n+    if e, ok := err.(*os.PathError); ok &amp;&amp; e.Err == syscall.ENOSPC {\n         deleteTempFiles()  // Recover some space.\n         continue\n     }\n```

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

変更されたコードスニペットは、Goにおけるエラー回復の一般的なパターンを示しています。

1.  **`file, err = os.Open(filename)` から `file, err = os.Create(filename)`**:
    *   元のコードでは`os.Open`を使用してファイルを読み取り専用で開こうとしていました。
    *   変更後では`os.Create`を使用しています。これは、ファイルが存在しない場合は作成し、存在する場合は内容を切り詰めて開く関数です。この変更は、ディスク容量不足からの回復という文脈において、新しいファイルを作成しようとするシナリオをより適切に表現しています。例えば、一時ファイルを書き込もうとして容量不足になった場合などです。

2.  **`if e, ok := err.(*os.PathError); ok && e.Err == os.ENOSPC {` から `if e, ok := err.(*os.PathError); ok && e.Err == syscall.ENOSPC {`**:
    *   この行は、返されたエラー`err`が`os.PathError`型であるかどうかを型アサーション`err.(*os.PathError)`で確認しています。`ok`変数はアサーションが成功したかどうかを示します。
    *   アサーションが成功した場合、さらに`e.Err == os.ENOSPC`という条件で、エラーがディスク容量不足（`ENOSPC`）によるものであるかをチェックしていました。
    *   変更後では、`os.ENOSPC`が削除されたため、代わりに`syscall.ENOSPC`を使用するように修正されています。これにより、コード例がGoの現在のAPIと一致し、正確なエラーチェックが行われるようになります。`syscall.ENOSPC`は、オペレーティングシステムが返す`ENOSPC`エラーコードをGoで表現したものです。

このコードブロック全体は、ファイル操作が失敗した場合に、それがディスク容量不足によるものであれば、一時ファイルを削除してスペースを確保し、操作を再試行するという回復ロジックを示しています。

## 関連リンク

*   Go言語の公式ドキュメント: [https://golang.org/doc/](https://golang.org/doc/)
*   Effective Go: [https://golang.org/doc/effective_go.html](https://golang.org/doc/effective_go.html) (このコミットで修正されたドキュメント)
*   Go `os`パッケージ: [https://pkg.go.dev/os](https://pkg.go.dev/os)
*   Go `syscall`パッケージ: [https://pkg.go.dev/syscall](https://pkg.go.dev/syscall)
*   Go CL 5866046: [https://golang.org/cl/5866046](https://golang.org/cl/5866046) (このコミットに対応するGerrit Change-Id)

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

*   Go言語のドキュメントとソースコード
*   Go言語のエラーハンドリングに関する一般的な知識
*   Unix/Linuxシステムにおける`ENOSPC`エラーコードの理解
*   `os.Open`と`os.Create`のGoドキュメント
*   Go言語の変更履歴やGerritのコミットログ (CL 5866046)
*   [https://pkg.go.dev/os#PathError](https://pkg.go.dev/os#PathError)
*   [https://pkg.go.dev/syscall#pkg-constants](https://pkg.go.dev/syscall#pkg-constants)
*   [https://pkg.go.dev/os#Open](https://pkg.go.dev/os#Open)
*   [https://pkg.go.dev/os#Create](https://pkg.go.dev/os#Create)
*   [https://github.com/golang/go/commit/e5102b35f6afaaf5a829768710d15924c126aeeb](https://github.com/golang/go/commit/e5102b35f6afaaf5a829768710d15924c126aeeb)
*   [https://golang.org/cl/5866046](https://golang.org/cl/5866046)