Merge pull request #1751 from liubin/fix/1750-fix-comments

runtime: fix some comments
This commit is contained in:
Chelsea Mafrica 2021-05-06 08:42:15 -07:00 committed by GitHub
commit 917665ab6d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -14,7 +14,7 @@ import (
) )
func startContainer(ctx context.Context, s *service, c *container) error { func startContainer(ctx context.Context, s *service, c *container) error {
//start a container // start a container
if c.cType == "" { if c.cType == "" {
err := fmt.Errorf("Bug, the container %s type is empty", c.id) err := fmt.Errorf("Bug, the container %s type is empty", c.id)
return err return err
@ -37,8 +37,8 @@ func startContainer(ctx context.Context, s *service, c *container) error {
} }
go watchSandbox(ctx, s) go watchSandbox(ctx, s)
// We don't rely on the context passed to startContainer as it can be cancelled after // We use s.ctx(`ctx` derived from `s.ctx`) to check for cancellation of the
// this rpc call. // shim context and the context passed to startContainer for tracing.
go watchOOMEvents(ctx, s) go watchOOMEvents(ctx, s)
} else { } else {
_, err := s.sandbox.StartContainer(ctx, c.id) _, err := s.sandbox.StartContainer(ctx, c.id)
@ -74,10 +74,10 @@ func startContainer(ctx context.Context, s *service, c *container) error {
c.ttyio = tty c.ttyio = tty
go ioCopy(c.exitIOch, c.stdinCloser, tty, stdin, stdout, stderr) go ioCopy(c.exitIOch, c.stdinCloser, tty, stdin, stdout, stderr)
} else { } else {
//close the io exit channel, since there is no io for this container, // close the io exit channel, since there is no io for this container,
//otherwise the following wait goroutine will hang on this channel. // otherwise the following wait goroutine will hang on this channel.
close(c.exitIOch) close(c.exitIOch)
//close the stdin closer channel to notify that it's safe to close process's // close the stdin closer channel to notify that it's safe to close process's
// io. // io.
close(c.stdinCloser) close(c.stdinCloser)
} }
@ -88,7 +88,7 @@ func startContainer(ctx context.Context, s *service, c *container) error {
} }
func startExec(ctx context.Context, s *service, containerID, execID string) (*exec, error) { func startExec(ctx context.Context, s *service, containerID, execID string) (*exec, error) {
//start an exec // start an exec
c, err := s.getContainer(containerID) c, err := s.getContainer(containerID)
if err != nil { if err != nil {
return nil, err return nil, err