docs: Various typo found by codespell

zhsj · zhsj · commit 5988bfc1efbc · 2020-12-22T13:22:16.000+08:00
Signed-off-by: Shengjing Zhu &lt;zhsj@debian.org&gt;
diff --git a/Makefile b/Makefile
@@ -227,7 +227,7 @@ man: mandir $(addprefix man/,$(MANPAGES))
 mandir:
 	@mkdir -p man
 
-# Kept for backwards compatability
+# Kept for backwards compatibility
 genman: man/containerd.8 man/ctr.8
 
 man/containerd.8: FORCE
diff --git a/container_linux_test.go b/container_linux_test.go
@@ -124,7 +124,7 @@ func TestRegressionIssue4769(t *testing.T) {
 	select {
 	case et := <-eventStream:
 		if et.Event == nil {
-			t.Fatal(errors.Errorf("unexpect empty event: %+v", et))
+			t.Fatal(errors.Errorf("unexpected empty event: %+v", et))
 		}
 
 		v, err := typeurl.UnmarshalAny(et.Event)
@@ -133,7 +133,7 @@ func TestRegressionIssue4769(t *testing.T) {
 		}
 
 		if e, ok := v.(*apievents.TaskExit); !ok {
-			t.Fatal(errors.Errorf("unexpect event type: %+v", v))
+			t.Fatal(errors.Errorf("unexpected event type: %+v", v))
 		} else if e.ExitStatus != 0 {
 			t.Fatal(errors.Errorf("expect zero exit status, but got %v", e.ExitStatus))
 		}
diff --git a/docs/man/containerd-config.toml.5.md b/docs/man/containerd-config.toml.5.md
@@ -34,7 +34,7 @@ settings.
 
 **imports**
 : Imports is a list of additional configuration files to include.
-This allows to split the main configuration file and keep some sections
+This allows one to split the main configuration file and keep some sections
 separately (for example vendors may keep a custom runtime configuration in a
 separate file without modifying the main `config.toml`).
 Imported files will overwrite simple fields like `int` or
diff --git a/docs/remote-snapshotter.md b/docs/remote-snapshotter.md
@@ -84,7 +84,7 @@ This is a containerd-defined label which contains ChainID that targets a committ
 At this moment, user-defined labels (prefixed by `containerd.io/snapshot/`) will also be merged into the labels option.
 
 ```go
-// Gets annotations appended to the targetting layer which would contain
+// Gets annotations appended to the targeting layer which would contain
 // snapshotter-specific information passed by the user.
 labels := snapshots.FilterInheritedLabels(desc.Annotations)
 if labels == nil {
@@ -98,7 +98,7 @@ labels["containerd.io/snapshot.ref"] = chainID
 // snapshotter-specific information passed by the user.
 opts := append(rCtx.SnapshotterOpts, snapshots.WithLabels(labels))
 
-// Calls `Prepare` API with target indentifier and snapshotter-specific
+// Calls `Prepare` API with target identifier and snapshotter-specific
 // information.
 mounts, err = sn.Prepare(ctx, key, parent.String(), opts...)
 ```
diff --git a/images/image.go b/images/image.go
@@ -289,7 +289,7 @@ func Platforms(ctx context.Context, provider content.Provider, image ocispec.Des
 // If available is true, the caller can assume that required represents the
 // complete set of content required for the image.
 //
-// missing will have the components that are part of required but not avaiiable
+// missing will have the components that are part of required but not available
 // in the provider.
 //
 // If there is a problem resolving content, an error will be returned.
diff --git a/namespaces/ttrpc_test.go b/namespaces/ttrpc_test.go
@@ -42,7 +42,7 @@ func TestCopyTTRPCMetadata(t *testing.T) {
 
 func TestTTRPCNamespaceHeader(t *testing.T) {
 	ctx := context.Background()
-	namespace := "test-namepace"
+	namespace := "test-namespace"
 	ctx = withTTRPCNamespaceHeader(ctx, namespace)
 
 	header, ok := fromTTRPCHeader(ctx)
diff --git a/pkg/cri/opts/spec_linux.go b/pkg/cri/opts/spec_linux.go
@@ -329,7 +329,7 @@ func WithDevices(osi osinterface.OS, config *runtime.ContainerConfig) oci.SpecOp
 	}
 }
 
-// WithCapabilities sets the provided capabilties from the security context
+// WithCapabilities sets the provided capabilities from the security context
 func WithCapabilities(sc *runtime.LinuxContainerSecurityContext) oci.SpecOpts {
 	capabilities := sc.GetCapabilities()
 	if capabilities == nil {
diff --git a/pkg/cri/server/bandwidth/fake_shaper.go b/pkg/cri/server/bandwidth/fake_shaper.go
@@ -38,7 +38,7 @@ import (
 	"k8s.io/apimachinery/pkg/api/resource"
 )
 
-// FakeShaper provides an implementation of the bandwith.Shaper.
+// FakeShaper provides an implementation of the bandwidth.Shaper.
 // Beware this is implementation has no features besides Reset and GetCIDRs.
 type FakeShaper struct {
 	CIDRs      []string
diff --git a/pkg/cri/server/bandwidth/utils.go b/pkg/cri/server/bandwidth/utils.go
@@ -46,7 +46,7 @@ func validateBandwidthIsReasonable(rsrc *resource.Quantity) error {
 		return fmt.Errorf("resource is unreasonably small (< 1kbit)")
 	}
 	if rsrc.Value() > maxRsrc.Value() {
-		return fmt.Errorf("resoruce is unreasonably large (> 1Pbit)")
+		return fmt.Errorf("resource is unreasonably large (> 1Pbit)")
 	}
 	return nil
 }
diff --git a/pkg/cri/server/container_stats_list_linux.go b/pkg/cri/server/container_stats_list_linux.go
@@ -92,7 +92,7 @@ func (c *criService) containerMetrics(
 				}
 			}
 		default:
-			return &cs, errors.Errorf("unxpected metrics type: %v", metrics)
+			return &cs, errors.Errorf("unexpected metrics type: %v", metrics)
 		}
 	}
 
diff --git a/pkg/cri/server/helpers_test.go b/pkg/cri/server/helpers_test.go
@@ -56,7 +56,7 @@ func TestGetUserFromImage(t *testing.T) {
 		"empty user": {
 			user: "",
 		},
-		"multiple spearators": {
+		"multiple separators": {
 			user: "1:2:3",
 			uid:  newI64(1),
 		},
@@ -99,7 +99,7 @@ func TestGetRepoDigestAndTag(t *testing.T) {
 			expectedRepoDigest: "",
 			expectedRepoTag:    "gcr.io/library/busybox:latest",
 		},
-		"repo digest should not be empty if orignal ref is schema1 but has digest": {
+		"repo digest should not be empty if original ref is schema1 but has digest": {
 			ref:                "gcr.io/library/busybox@sha256:e6693c20186f837fc393390135d8a598a96a833917917789d63766cab6c59594",
 			schema1:            true,
 			expectedRepoDigest: "gcr.io/library/busybox@sha256:e6693c20186f837fc393390135d8a598a96a833917917789d63766cab6c59594",
diff --git a/pkg/cri/server/restart.go b/pkg/cri/server/restart.go
@@ -47,7 +47,7 @@ import (
 // 2) Containerd containers may be deleted, but SHOULD NOT be added. Or else, recovery logic
 // for the newly added container/sandbox will return error, because there is no corresponding root
 // directory created.
-// 3) Containerd container tasks may exit or be stoppped, deleted. Even though current logic could
+// 3) Containerd container tasks may exit or be stopped, deleted. Even though current logic could
 // tolerant tasks being created or started, we prefer that not to happen.
 
 // recover recovers system state from containerd and status checkpoint.
@@ -264,7 +264,7 @@ func (c *criService) loadContainer(ctx context.Context, cntr containerd.Containe
 					return errors.Errorf("unexpected container state for created task: %q", status.State())
 				}
 			case containerd.Running:
-				// Task is running. Container must be in `RUNNING` state, based on our assuption that
+				// Task is running. Container must be in `RUNNING` state, based on our assumption that
 				// "task should not be started when containerd is down".
 				switch status.State() {
 				case runtime.ContainerState_CONTAINER_EXITED:
diff --git a/pkg/cri/store/container/status.go b/pkg/cri/store/container/status.go
@@ -156,7 +156,7 @@ type StatusStorage interface {
 	// Delete the container status.
 	// Note:
 	// * Delete should be idempotent.
-	// * The status must be deleted in one trasaction.
+	// * The status must be deleted in one transaction.
 	Delete() error
 }
 
diff --git a/pkg/netns/netns_linux.go b/pkg/netns/netns_linux.go
@@ -175,7 +175,7 @@ func LoadNetNS(path string) *NetNS {
 	return &NetNS{path: path}
 }
 
-// Remove removes network namepace. Remove is idempotent, meaning it might
+// Remove removes network namespace. Remove is idempotent, meaning it might
 // be invoked multiple times and provides consistent result.
 func (n *NetNS) Remove() error {
 	return unmountNS(n.path)
diff --git a/pkg/netns/netns_other.go b/pkg/netns/netns_other.go
@@ -39,7 +39,7 @@ func LoadNetNS(path string) *NetNS {
 	return &NetNS{path: path}
 }
 
-// Remove removes network namepace. Remove is idempotent, meaning it might
+// Remove removes network namespace. Remove is idempotent, meaning it might
 // be invoked multiple times and provides consistent result.
 func (n *NetNS) Remove() error {
 	return errNotImplementedOnUnix
diff --git a/pkg/netns/netns_windows.go b/pkg/netns/netns_windows.go
@@ -41,7 +41,7 @@ func LoadNetNS(path string) *NetNS {
 	return &NetNS{path: path}
 }
 
-// Remove removes network namepace if it exists and not closed. Remove is idempotent,
+// Remove removes network namespace if it exists and not closed. Remove is idempotent,
 // meaning it might be invoked multiple times and provides consistent result.
 func (n *NetNS) Remove() error {
 	hcnNamespace, err := hcn.GetNamespaceByID(n.path)
diff --git a/remotes/docker/auth/fetch.go b/remotes/docker/auth/fetch.go
@@ -65,7 +65,7 @@ func GenerateTokenOptions(ctx context.Context, host, username, secret string, c
 	return to, nil
 }
 
-// TokenOptions are optios for requesting a token
+// TokenOptions are options for requesting a token
 type TokenOptions struct {
 	Realm    string
 	Service  string
diff --git a/remotes/docker/errcode.go b/remotes/docker/errcode.go
@@ -163,7 +163,7 @@ type ErrorDescriptor struct {
 	// keyed value when serializing api errors.
 	Value string
 
-	// Message is a short, human readable decription of the error condition
+	// Message is a short, human readable description of the error condition
 	// included in API responses.
 	Message string
 
diff --git a/reports/2017-04-28.md b/reports/2017-04-28.md
@@ -43,7 +43,7 @@ If are you looking for areas to contribute to containerd just take a pass throug
 
 ## containerd Summit Notes
 
-Here are the notes from the containerd summit that was held after Dockercon.  If there are important to you and you would like to start working on a feature, fix, request, please go ahead and open an issue on github.  Just remember, we shouldn't have to have a summit to get things into containerd.  Open issues, disscuss with other members of the community and write the code ;)
+Here are the notes from the containerd summit that was held after Dockercon.  If there are important to you and you would like to start working on a feature, fix, request, please go ahead and open an issue on github.  Just remember, we shouldn't have to have a summit to get things into containerd.  Open issues, discuss with other members of the community and write the code ;)
 
 * “Since containerd is one of the bottom bricks in the stack, how can we setup automated integration tests for consumers of containerd?”
 	- Looking for others to provide compute (testing within Docker, K8s, Microsoft)
diff --git a/snapshots/devmapper/snapshotter.go b/snapshots/devmapper/snapshotter.go
@@ -247,7 +247,7 @@ func (s *Snapshotter) Commit(ctx context.Context, name, key string, opts ...snap
 		}
 
 		// After committed, the snapshot device will not be directly
-		// used anymore. We'd better deativate it to make it *invisible*
+		// used anymore. We'd better deactivate it to make it *invisible*
 		// in userspace, so that tools like LVM2 and fdisk cannot touch it,
 		// and avoid useless IOs on it.
 		//
diff --git a/test/push.sh b/test/push.sh
@@ -24,7 +24,7 @@ source $(dirname "${BASH_SOURCE[0]}")/utils.sh
 DEPLOY_BUCKET=${DEPLOY_BUCKET:-"cri-containerd-staging"}
 # DEPLOY_DIR is the directory in the gcs bucket to store the tarball.
 DEPLOY_DIR=${DEPLOY_DIR:-""}
-# BUILD_DIR is the directory of the bulid out.
+# BUILD_DIR is the directory of the build out.
 BUILD_DIR=${BUILD_DIR:-"_output"}
 # TARBALL is the tarball name.
 TARBALL=${TARBALL:-"cri-containerd.tar.gz"}

Original file line number	Diff line number	Diff line change
`@@ -124,7 +124,7 @@ func TestRegressionIssue4769(t *testing.T) {`
`124`	`124`	`select {`
`125`	`125`	`case et := <-eventStream:`
`126`	`126`	`if et.Event == nil {`
`127`		`- t.Fatal(errors.Errorf("unexpect empty event: %+v", et))`
	`127`	`+ t.Fatal(errors.Errorf("unexpected empty event: %+v", et))`
`128`	`128`	`}`
`129`	`129`
`130`	`130`	`v, err := typeurl.UnmarshalAny(et.Event)`
`@@ -133,7 +133,7 @@ func TestRegressionIssue4769(t *testing.T) {`
`133`	`133`	`}`
`134`	`134`
`135`	`135`	`if e, ok := v.(*apievents.TaskExit); !ok {`
`136`		`- t.Fatal(errors.Errorf("unexpect event type: %+v", v))`
	`136`	`+ t.Fatal(errors.Errorf("unexpected event type: %+v", v))`
`137`	`137`	`} else if e.ExitStatus != 0 {`
`138`	`138`	`t.Fatal(errors.Errorf("expect zero exit status, but got %v", e.ExitStatus))`
`139`	`139`	`}`
Original file line number	Diff line number	Diff line change
`@@ -329,7 +329,7 @@ func WithDevices(osi osinterface.OS, config *runtime.ContainerConfig) oci.SpecOp`
`329`	`329`	`}`
`330`	`330`	`}`
`331`	`331`
`332`		`-// WithCapabilities sets the provided capabilties from the security context`
	`332`	`+// WithCapabilities sets the provided capabilities from the security context`
`333`	`333`	`func WithCapabilities(sc *runtime.LinuxContainerSecurityContext) oci.SpecOpts {`
`334`	`334`	`capabilities := sc.GetCapabilities()`
`335`	`335`	`if capabilities == nil {`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ import (`
`38`	`38`	`"k8s.io/apimachinery/pkg/api/resource"`
`39`	`39`	`)`
`40`	`40`
`41`		`-// FakeShaper provides an implementation of the bandwith.Shaper.`
	`41`	`+// FakeShaper provides an implementation of the bandwidth.Shaper.`
`42`	`42`	`// Beware this is implementation has no features besides Reset and GetCIDRs.`
`43`	`43`	`type FakeShaper struct {`
`44`	`44`	`CIDRs []string`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ func validateBandwidthIsReasonable(rsrc *resource.Quantity) error {`
`46`	`46`	`return fmt.Errorf("resource is unreasonably small (< 1kbit)")`
`47`	`47`	`}`
`48`	`48`	`if rsrc.Value() > maxRsrc.Value() {`
`49`		`- return fmt.Errorf("resoruce is unreasonably large (> 1Pbit)")`
	`49`	`+ return fmt.Errorf("resource is unreasonably large (> 1Pbit)")`
`50`	`50`	`}`
`51`	`51`	`return nil`
`52`	`52`	`}`
Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,7 @@ func (c *criService) containerMetrics(`
`92`	`92`	`}`
`93`	`93`	`}`
`94`	`94`	`default:`
`95`		`- return &cs, errors.Errorf("unxpected metrics type: %v", metrics)`
	`95`	`+ return &cs, errors.Errorf("unexpected metrics type: %v", metrics)`
`96`	`96`	`}`
`97`	`97`	`}`
`98`	`98`