diff options
author | Ian Lance Taylor <iant@golang.org> | 2021-01-21 16:23:18 -0800 |
---|---|---|
committer | Ian Lance Taylor <iant@golang.org> | 2021-01-25 22:54:28 +0000 |
commit | e6b6d107f7157bb515564f628e5b9b455e295db3 (patch) | |
tree | 7c1e0259dc06264ce43d705afeeaf0bd2486245b /doc | |
parent | 96a276363b130d0f0e5185f2f17c0f6bce43f885 (diff) | |
download | go-e6b6d107f7157bb515564f628e5b9b455e295db3.tar.gz go-e6b6d107f7157bb515564f628e5b9b455e295db3.zip |
doc/go1.16: mention deprecation of io/ioutil
For #40025
For #40700
For #42026
Change-Id: Ib51b5e1398c4eb811506df21e3bd56dd84bd1f7e
Reviewed-on: https://go-review.googlesource.com/c/go/+/285377
Trust: Ian Lance Taylor <iant@golang.org>
Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/go1.16.html | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/doc/go1.16.html b/doc/go1.16.html index 0330ec6b24..37a2160944 100644 --- a/doc/go1.16.html +++ b/doc/go1.16.html @@ -499,6 +499,44 @@ func TestFoo(t *testing.T) { implementations. </p> +<h3 id="ioutil">Deprecation of io/ioutil</h3> + +<p> + The <a href="/pkg/io/ioutil/"><code>io/ioutil</code></a> package has + turned out to be a poorly defined and hard to understand collection + of things. All functionality provided by the package has been moved + to other packages. The <code>io/ioutil</code> package remains and + will continue to work as before, but we encourage new code to use + the new definitions in the <a href="/pkg/io/"><code>io</code></a> and + <a href="/pkg/os/"><code>os</code></a> packages. + + Here is a list of the new locations of the names exported + by <code>io/ioutil</code>: + <ul> + <li><a href="/pkg/io/ioutil/#Discard"><code>Discard</code></a> + => <a href="/pkg/io/#Discard"><code>io.Discard</code></a></li> + <li><a href="/pkg/io/ioutil/#NopCloser"><code>NopCloser</code></a> + => <a href="/pkg/io/#NopCloser"><code>io.NopCloser</code></a></li> + <li><a href="/pkg/io/ioutil/#ReadAll"><code>ReadAll</code></a> + => <a href="/pkg/io/#ReadAll"><code>io.ReadAll</code></a></li> + <li><a href="/pkg/io/ioutil/#ReadDir"><code>ReadDir</code></a> + => <a href="/pkg/os/#ReadDir"><code>os.ReadDir</code></a> + (note: returns a slice of + <a href="/pkg/os/#DirEntry"><code>os.DirEntry</code></a> + rather than a slice of + <a href="/pkg/fs/#FileInfo"><code>fs.FileInfo</code></a>) + </li> + <li><a href="/pkg/io/ioutil/#ReadFile"><code>ReadFile</code></a> + => <a href="/pkg/os/#ReadFile"><code>os.ReadFile</code></a></li> + <li><a href="/pkg/io/ioutil/#TempDir"><code>TempDir</code></a> + => <a href="/pkg/os/#MkdirTemp"><code>os.MkdirTemp</code></a></li> + <li><a href="/pkg/io/ioutil/#TempFile"><code>TempFile</code></a> + => <a href="/pkg/os/#CreateTemp"><code>os.CreateTemp</code></a></li> + <li><a href="/pkg/io/ioutil/#WriteFile"><code>WriteFile</code></a> + => <a href="/pkg/os/#WriteFile"><code>os.WriteFile</code></a></li> + </ul> +</p> + <!-- okay-after-beta1 TODO: decide if any additional changes are worth factoring out from "Minor changes to the library" and highlighting in "Core library" @@ -742,6 +780,15 @@ func TestFoo(t *testing.T) { The package now defines a <a href="/pkg/io/#ReadSeekCloser"><code>ReadSeekCloser</code></a> interface. </p> + + <p><!-- CL 263141 --> + The package now defines + <a href="/pkg/io/#Discard"><code>Discard</code></a>, + <a href="/pkg/io/#NopCloser"><code>NopCloser</code></a>, and + <a href="/pkg/io/#ReadAll"><code>ReadAll</code></a>, + to be used instead of the same names in the + <a href="/pkg/io/ioutil/"><code>io/ioutil</code></a> package. + </p> </dd> </dl><!-- io --> @@ -896,6 +943,16 @@ func TestFoo(t *testing.T) { instead of the unexported <code>errFinished</code> when the process has already finished. </p> + + <p><!-- CL 263141 --> + The package now defines + <a href="/pkg/os/#CreateTemp"><code>CreateTemp</code></a>, + <a href="/pkg/os/#MkdirTemp"><code>MkdirTemp</code></a>, + <a href="/pkg/os/#ReadFile"><code>ReadFile</code></a>, and + <a href="/pkg/os/#WriteFile"><code>WriteFile</code></a>, + to be used instead of functions defined in the + <a href="/pkg/io/ioutil/"><code>io/ioutil</code></a> package. + </p> </dd> </dl><!-- os --> |