io/ioutil: flag package and functions with the Deprecated marker

All implementations are now part of `io` or `os` packages, per #42026.
Flag all implementations in `ioutil`, and the package itself, with
the Deprecated marker so that tooling can pick it up and interpret
it accordingly.

Updates #42026
This commit is contained in:
Florin Pățan 2021-01-20 10:49:01 +02:00 committed by Jeff Widman
parent 0652274c10
commit aae1fbdd37
1 changed files with 7 additions and 7 deletions

View File

@ -4,7 +4,7 @@
// Package ioutil implements some I/O utility functions.
//
// As of Go 1.16, the same functionality is now provided
// Deprecated: As of Go 1.16, the same functionality is now provided
// by package io or package os, and those implementations
// should be preferred in new code.
// See the specific function documentation for details.
@ -22,7 +22,7 @@ import (
// defined to read from src until EOF, it does not treat an EOF from Read
// as an error to be reported.
//
// As of Go 1.16, this function simply calls io.ReadAll.
// Deprecated: As of Go 1.16, this function simply calls io.ReadAll.
func ReadAll(r io.Reader) ([]byte, error) {
return io.ReadAll(r)
}
@ -32,7 +32,7 @@ func ReadAll(r io.Reader) ([]byte, error) {
// reads the whole file, it does not treat an EOF from Read as an error
// to be reported.
//
// As of Go 1.16, this function simply calls os.ReadFile.
// Deprecated: As of Go 1.16, this function simply calls os.ReadFile.
func ReadFile(filename string) ([]byte, error) {
return os.ReadFile(filename)
}
@ -41,7 +41,7 @@ func ReadFile(filename string) ([]byte, error) {
// If the file does not exist, WriteFile creates it with permissions perm
// (before umask); otherwise WriteFile truncates it before writing, without changing permissions.
//
// As of Go 1.16, this function simply calls os.WriteFile.
// Deprecated: As of Go 1.16, this function simply calls os.WriteFile.
func WriteFile(filename string, data []byte, perm fs.FileMode) error {
return os.WriteFile(filename, data, perm)
}
@ -51,7 +51,7 @@ func WriteFile(filename string, data []byte, perm fs.FileMode) error {
// sorted by filename. If an error occurs reading the directory,
// ReadDir returns no directory entries along with the error.
//
// As of Go 1.16, os.ReadDir is a more efficient and correct choice:
// Deprecated: As of Go 1.16, os.ReadDir is a more efficient and correct choice:
// it returns a list of fs.DirEntry instead of fs.FileInfo,
// and it returns partial results in the case of an error
// midway through reading a directory.
@ -72,7 +72,7 @@ func ReadDir(dirname string) ([]fs.FileInfo, error) {
// NopCloser returns a ReadCloser with a no-op Close method wrapping
// the provided Reader r.
//
// As of Go 1.16, this function simply calls io.NopCloser.
// Deprecated: As of Go 1.16, this function simply calls io.NopCloser.
func NopCloser(r io.Reader) io.ReadCloser {
return io.NopCloser(r)
}
@ -80,5 +80,5 @@ func NopCloser(r io.Reader) io.ReadCloser {
// Discard is an io.Writer on which all Write calls succeed
// without doing anything.
//
// As of Go 1.16, this value is simply io.Discard.
// Deprecated: As of Go 1.16, this value is simply io.Discard.
var Discard io.Writer = io.Discard