Skip to content

Commit

Permalink
update docs and comments
Browse files Browse the repository at this point in the history
Signed-off-by: Allen Sun <shlallen1990@gmail.com>
  • Loading branch information
allencloud authored and Allen Sun committed Sep 25, 2017
1 parent 709d34f commit 4700968
Show file tree
Hide file tree
Showing 6 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion design/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ is simply a directory on the filesystem.

![Architecture](architecture.png)

Note that while these architectural ideas are important to understanding the
Note that while these architectural ideas are important to understand the
system, code layout may not reflect the exact architecture. These ideas should
be used as a guide for placing functionality and behavior and understanding the
thought behind the design.
Expand Down
2 changes: 1 addition & 1 deletion design/lifecycle.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Container Lifecycle

While containerd is a daemon that provides API to manage multiple containers, the containers themselves are not tied to the lifecycle of containerd. Each container has a shim that acts as the direct parent for the container's processes as well has reporting the exit status and holding onto the STDIO of the container. This also allows containerd to crash and restore all functionality to containers.
While containerd is a daemon that provides API to manage multiple containers, the containers themselves are not tied to the lifecycle of containerd. Each container has a shim that acts as the direct parent for the container's processes as well as reporting the exit status and holding onto the STDIO of the container. This also allows containerd to crash and restore all functionality to containers.


## containerd
Expand Down
2 changes: 1 addition & 1 deletion remotes/handlers.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import (
"github.com/sirupsen/logrus"
)

// MakeRef returns a unique reference for the descriptor. This reference can be
// MakeRefKey returns a unique reference for the descriptor. This reference can be
// used to lookup ongoing processes related to the descriptor. This function
// may look to the context to namespace the reference appropriately.
func MakeRefKey(ctx context.Context, desc ocispec.Descriptor) string {
Expand Down
2 changes: 1 addition & 1 deletion server/server_linux.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ const (
DefaultStateDir = "/run/containerd"
// DefaultAddress is the default unix socket address
DefaultAddress = "/run/containerd/containerd.sock"
// DefaultDebuggAddress is the default unix socket address for pprof data
// DefaultDebugAddress is the default unix socket address for pprof data
DefaultDebugAddress = "/run/containerd/debug.sock"
)

Expand Down
2 changes: 1 addition & 1 deletion server/server_solaris.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import "context"
const (
// DefaultAddress is the default unix socket address
DefaultAddress = "/var/run/containerd/containerd.sock"
// DefaultDebuggAddress is the default unix socket address for pprof data
// DefaultDebugAddress is the default unix socket address for pprof data
DefaultDebugAddress = "/var/run/containerd/debug.sock"
)

Expand Down
2 changes: 1 addition & 1 deletion server/server_unsupported.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ const (
DefaultStateDir = "/run/containerd"
// DefaultAddress is the default unix socket address
DefaultAddress = "/run/containerd/containerd.sock"
// DefaultDebuggAddress is the default unix socket address for pprof data
// DefaultDebugAddress is the default unix socket address for pprof data
DefaultDebugAddress = "/run/containerd/debug.sock"
)

Expand Down

0 comments on commit 4700968

Please sign in to comment.