Guest24897
/
DockerCLI
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #4154 from thaJeztah/23.0_backport_fix_deprecation_message 

[23.0 backport] cli/command: fix deprecation comments for Stream types
This commit is contained in:
Sebastiaan van Stijn 2023-04-05 17:01:59 +02:00 committed by GitHub
parent 683b099613 6efc4eaccb
commit 06ab5992dc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
cli/command/streams.go
View File

@ -1,23 +1,32 @@
package command package command
import ( import (
"io"
"github.com/docker/cli/cli/streams" "github.com/docker/cli/cli/streams"
) )
// InStream is an input stream used by the DockerCli to read user input // InStream is an input stream used by the DockerCli to read user input
// Deprecated: Use github.com/docker/cli/cli/streams.In instead //
// Deprecated: Use [streams.In] instead.
type InStream = streams.In type InStream = streams.In
// OutStream is an output stream used by the DockerCli to write normal program // OutStream is an output stream used by the DockerCli to write normal program
// output. // output.
// Deprecated: Use github.com/docker/cli/cli/streams.Out instead //
// Deprecated: Use [streams.Out] instead.
type OutStream = streams.Out type OutStream = streams.Out
var ( // NewInStream returns a new [streams.In] from an [io.ReadCloser].
// NewInStream returns a new InStream object from a ReadCloser //
// Deprecated: Use github.com/docker/cli/cli/streams.NewIn instead // Deprecated: Use [streams.NewIn] instead.
NewInStream = streams.NewIn func NewInStream(in io.ReadCloser) *streams.In {
// NewOutStream returns a new OutStream object from a Writer return streams.NewIn(in)
// Deprecated: Use github.com/docker/cli/cli/streams.NewOut instead }
NewOutStream = streams.NewOut
) // NewOutStream returns a new [streams.Out] from an [io.Writer].
//
// Deprecated: Use [streams.NewOut] instead.
func NewOutStream(out io.Writer) *streams.Out {
return streams.NewOut(out)
}