Perfect documentation

yuxiaobo96 · yuxiaobo96 · commit 5ea936362474 · 2019-09-25T16:59:31.000+08:00
Signed-off-by: yuxiaobo &lt;yuxiaobogo@163.com&gt;
diff --git a/metadata/db.go b/metadata/db.go
@@ -76,7 +76,7 @@ type DB struct {
 	// sweep phases without preventing read transactions.
 	wlock sync.RWMutex
 
-	// dirty flag indicates that refences have been removed which require
+	// dirty flag indicates that references have been removed which require
 	// a garbage collection to ensure the database is clean. This tracks
 	// the number of dirty operations. This should be updated and read
 	// atomically if outside of wlock.Lock.
diff --git a/namespaces/context.go b/namespaces/context.go
@@ -64,7 +64,7 @@ func Namespace(ctx context.Context) (string, bool) {
 	return namespace, ok
 }
 
-// NamespaceRequired returns the valid namepace from the context or an error.
+// NamespaceRequired returns the valid namespace from the context or an error.
 func NamespaceRequired(ctx context.Context) (string, error) {
 	namespace, ok := Namespace(ctx)
 	if !ok || namespace == "" {
diff --git a/reports/2017-01-13.md b/reports/2017-01-13.md
@@ -37,7 +37,7 @@ We finished porting over the shim from the existing containerd implementation th
 
 * https://github.com/containerd/containerd/pull/417
 
-## Whats Next?
+## What's Next?
 
 Next week we will be working towards a full PoC with the runtime, storage, and fetching of images.  Getting the core functionality up and running quickly is important to us to ensure that integration between the different subsystems in the core flow well together.  We want to make sure the responsibilities of pulling an image from a remote source do not spill into the storage layer and vice-versa.
 
diff --git a/reports/2017-04-28.md b/reports/2017-04-28.md
@@ -26,7 +26,7 @@ Justin has begun work on porting over containerd to Darwin and BSD.  `ctr` compi
 
 ## Task List for week of May 1
 
-So, now that we are all back from Dockercon and not rested at all, whats on the agenda for next week?
+So, now that we are all back from Dockercon and not rested at all, what's on the agenda for next week?
 
 * Docker Integration Pass
 	- Replace the current v0.2.x branch of containerd in Docker for execution with the 1.0 execution service
diff --git a/reports/2017-05-19.md b/reports/2017-05-19.md
@@ -4,7 +4,7 @@
 
 Moving more functionality into containerd means more requirements from users.  One thing that we have ran into was the disconnect of what our Container model is and what users expect, `docker create;docker start;docker rm` vs a container that is destroyed when it exits.
 
-To users, containers are more of a metadata object that resources(rw, configuration) and information(state, last exit status) are attached to.  We have been reworking what we call a "container" today to be called a "task" and a Container metadata object.  The task only has runtime state:  a pid, namepsaces, cgroups, etc.  A container has an id, root filesystem, configuration, and other metadata from a user.
+To users, containers are more of a metadata object that resources(rw, configuration) and information(state, last exit status) are attached to.  We have been reworking what we call a "container" today to be called a "task" and a Container metadata object.  The task only has runtime state:  a pid, namespaces, cgroups, etc.  A container has an id, root filesystem, configuration, and other metadata from a user.
 
 Managing static state and runtime state in the same object is very tricky so we choose to keep execution and metadata separate.  We are hoping to not cause more confusion with this additional task object.  You can see a mockup of a client interacting with a container and how the task is handled below:
 
diff --git a/reports/2017-05-26.md b/reports/2017-05-26.md
@@ -124,7 +124,7 @@ We also designed the client to allow mocking of calls so that our tests can be m
 You can view the PR [here](https://github.com/containerd/containerd/pull/910).
 
 
-## Whats Next?
+## What's Next?
 
 We still need to finish Events.  This is one of the last major features that we need before we consider containerd feature complete.  The namespace work is in progress with the initial service spec'd.
 
diff --git a/reports/2017-06-09.md b/reports/2017-06-09.md
@@ -28,7 +28,7 @@ We added updates to the client to support attach, checkpoint and restore, exec o
 [checkpoint](https://github.com/containerd/containerd/pull/958)
 [attach](https://github.com/containerd/containerd/pull/976)
 
-# Whats Next?
+# What's Next?
 
 We only have a few features left to implement, such as [events](https://github.com/containerd/containerd/pull/956), for our 1.0 release.  The rest of the month we are working on usability, bug fixes, and stability.
 

Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,7 @@ func Namespace(ctx context.Context) (string, bool) {`
`64`	`64`	`return namespace, ok`
`65`	`65`	`}`
`66`	`66`
`67`		`-// NamespaceRequired returns the valid namepace from the context or an error.`
	`67`	`+// NamespaceRequired returns the valid namespace from the context or an error.`
`68`	`68`	`func NamespaceRequired(ctx context.Context) (string, error) {`
`69`	`69`	`namespace, ok := Namespace(ctx)`
`70`	`70`	`if !ok \|\| namespace == "" {`