fix nits in comments

allencloud · allencloud · commit bc85efdb4fa6 · 2016-12-28T18:49:18.000+08:00
Signed-off-by: allencloud &lt;allen.sun@daocloud.io&gt;
diff --git a/libnetwork/controller.go b/libnetwork/controller.go
@@ -273,7 +273,7 @@ func (c *controller) SetKeys(keys []*types.EncryptionKey) error {
 	}
 	for s, count := range subsysKeys {
 		if count != keyringSize {
-			return fmt.Errorf("incorrect number of keys for susbsystem %v", s)
+			return fmt.Errorf("incorrect number of keys for subsystem %v", s)
 		}
 	}
 
@@ -582,7 +582,7 @@ func (c *controller) pushNodeDiscovery(d driverapi.Driver, cap driverapi.Capabil
 			err = d.DiscoverDelete(discoverapi.NodeDiscovery, nodeData)
 		}
 		if err != nil {
-			logrus.Debugf("discovery notification error : %v", err)
+			logrus.Debugf("discovery notification error: %v", err)
 		}
 	}
 }
@@ -997,7 +997,7 @@ func (c *controller) NewSandbox(containerID string, options ...SandboxOption) (s
 
 	err = sb.storeUpdate()
 	if err != nil {
-		return nil, fmt.Errorf("updating the store state of sandbox failed: %v", err)
+		return nil, fmt.Errorf("failed to update the store state of sandbox: %v", err)
 	}
 
 	return sb, nil
diff --git a/libnetwork/docs/macvlan.md b/libnetwork/docs/macvlan.md
@@ -38,7 +38,7 @@ There are positive performance implication as a result of bypassing the Linux br
 
 - The driver limits one network per parent interface. The driver does however accommodate secondary subnets to be allocated in a single Docker network for a multi-subnet requirement. The upstream router is responsible for proxy-arping between the two subnets.
 
-- Any Macvlan container sharing the same subnet can communicate via IP to any other container in the same subnet without a gateway. It is important to note, that the parent will go into promiscuous mode when a container is attached to the parent since each container has a unique MAC address. Alternatively, Ipvlan which is currently a experimental driver uses the same MAC address as the parent interface and thus precluding the need for the parent being promiscuous.
+- Any Macvlan container sharing the same subnet can communicate via IP to any other container in the same subnet without a gateway. It is important to note, that the parent will go into promiscuous mode when a container is attached to the parent since each container has a unique MAC address. Alternatively, Ipvlan which is currently an experimental driver uses the same MAC address as the parent interface and thus precluding the need for the parent being promiscuous.
 
 In the following example, `eth0` on the docker host has an IP on the `172.16.86.0/24` network and a default gateway of `172.16.86.1`. The gateway is an external router with an address of `172.16.86.1`. An IP address is not required on the Docker host interface `eth0` in `bridge` mode, it merely needs to be on the proper upstream network to get forwarded by a network switch or network router.
 
@@ -150,7 +150,7 @@ In the case of a host reboot, instead of needing to modify often complex network
 
 The same holds true if the network is deleted `docker network rm`. If driver created the sub-interface with `docker network create` it will remove the sub-interface link for the operator.
 
-If the user doesn't want Docker to create and delete the `-o parent` sub-interface, then you simply pass a interface that already exists as the parent link. Parent interfaces such as `eth0` are not deleted, only interfaces that are slave links.
+If the user doesn't want Docker to create and delete the `-o parent` sub-interface, then you simply pass an interface that already exists as the parent link. Parent interfaces such as `eth0` are not deleted, only interfaces that are slave links.
 
 For the driver to add/delete the vlan sub-interfaces the format needs to be `-o parent interface_name.vlan_tag`.
 
diff --git a/libnetwork/driverapi/driverapi.go b/libnetwork/driverapi/driverapi.go
@@ -62,7 +62,7 @@ type Driver interface {
 	// programming to allow the external connectivity dictated by the passed options
 	ProgramExternalConnectivity(nid, eid string, options map[string]interface{}) error
 
-	// RevokeExternalConnectivity aks the driver to remove any external connectivity
+	// RevokeExternalConnectivity asks the driver to remove any external connectivity
 	// programming that was done so far
 	RevokeExternalConnectivity(nid, eid string) error
 
@@ -72,7 +72,7 @@ type Driver interface {
 	// only invoked for the global scope driver.
 	EventNotify(event EventType, nid string, tableName string, key string, value []byte)
 
-	// Type returns the the type of this driver, the network type this driver manages
+	// Type returns the type of this driver, the network type this driver manages
 	Type() string
 
 	// IsBuiltIn returns true if it is a built-in driver
diff --git a/libnetwork/drivers/windows/overlay/peerdb_windows.go b/libnetwork/drivers/windows/overlay/peerdb_windows.go
@@ -81,7 +81,7 @@ func (d *driver) peerAdd(nid, eid string, peerIP net.IP, peerIPMask net.IPMask,
 			return err
 		}
 
-		// Temp: We have to create a endpoint object to keep track of the HNS ID for
+		// Temp: We have to create an endpoint object to keep track of the HNS ID for
 		// this endpoint so that we can retrieve it later when the endpoint is deleted.
 		// This seems unnecessary when we already have dockers EID. See if we can pass
 		// the global EID to HNS to use as it's ID, rather than having each HNS assign
diff --git a/libnetwork/libnetwork_linux_test.go b/libnetwork/libnetwork_linux_test.go
@@ -318,7 +318,7 @@ func TestEndpointJoin(t *testing.T) {
 	}
 
 	if info.Sandbox() == nil {
-		t.Fatalf("Expected an non-empty sandbox key for a joined endpoint. Instead found a empty sandbox key")
+		t.Fatalf("Expected an non-empty sandbox key for a joined endpoint. Instead found an empty sandbox key")
 	}
 
 	// Check endpoint provided container information
diff --git a/libnetwork/sandbox.go b/libnetwork/sandbox.go
@@ -45,7 +45,7 @@ type Sandbox interface {
 	// EnableService  makes a managed container's service available by adding the
 	// endpoint to the service load balancer and service discovery
 	EnableService() error
-	// DisableService removes a managed contianer's endpoints from the load balancer
+	// DisableService removes a managed container's endpoints from the load balancer
 	// and service discovery
 	DisableService() error
 }

Original file line number	Diff line number	Diff line change
`@@ -273,7 +273,7 @@ func (c controller) SetKeys(keys []types.EncryptionKey) error {`
`273`	`273`	`}`
`274`	`274`	`for s, count := range subsysKeys {`
`275`	`275`	`if count != keyringSize {`
`276`		`- return fmt.Errorf("incorrect number of keys for susbsystem %v", s)`
	`276`	`+ return fmt.Errorf("incorrect number of keys for subsystem %v", s)`
`277`	`277`	`}`
`278`	`278`	`}`
`279`	`279`
`@@ -582,7 +582,7 @@ func (c *controller) pushNodeDiscovery(d driverapi.Driver, cap driverapi.Capabil`
`582`	`582`	`err = d.DiscoverDelete(discoverapi.NodeDiscovery, nodeData)`
`583`	`583`	`}`
`584`	`584`	`if err != nil {`
`585`		`- logrus.Debugf("discovery notification error : %v", err)`
	`585`	`+ logrus.Debugf("discovery notification error: %v", err)`
`586`	`586`	`}`
`587`	`587`	`}`
`588`	`588`	`}`
`@@ -997,7 +997,7 @@ func (c *controller) NewSandbox(containerID string, options ...SandboxOption) (s`
`997`	`997`
`998`	`998`	`err = sb.storeUpdate()`
`999`	`999`	`if err != nil {`
`1000`		`- return nil, fmt.Errorf("updating the store state of sandbox failed: %v", err)`
	`1000`	`+ return nil, fmt.Errorf("failed to update the store state of sandbox: %v", err)`
`1001`	`1001`	`}`
`1002`	`1002`
`1003`	`1003`	`return sb, nil`
Original file line number	Diff line number	Diff line change
`@@ -81,7 +81,7 @@ func (d *driver) peerAdd(nid, eid string, peerIP net.IP, peerIPMask net.IPMask,`
`81`	`81`	`return err`
`82`	`82`	`}`
`83`	`83`
`84`		`- // Temp: We have to create a endpoint object to keep track of the HNS ID for`
	`84`	`+ // Temp: We have to create an endpoint object to keep track of the HNS ID for`
`85`	`85`	`// this endpoint so that we can retrieve it later when the endpoint is deleted.`
`86`	`86`	`// This seems unnecessary when we already have dockers EID. See if we can pass`
`87`	`87`	`// the global EID to HNS to use as it's ID, rather than having each HNS assign`
Original file line number	Diff line number	Diff line change
`@@ -318,7 +318,7 @@ func TestEndpointJoin(t *testing.T) {`
`318`	`318`	`}`
`319`	`319`
`320`	`320`	`if info.Sandbox() == nil {`
`321`		`- t.Fatalf("Expected an non-empty sandbox key for a joined endpoint. Instead found a empty sandbox key")`
	`321`	`+ t.Fatalf("Expected an non-empty sandbox key for a joined endpoint. Instead found an empty sandbox key")`
`322`	`322`	`}`
`323`	`323`
`324`	`324`	`// Check endpoint provided container information`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ type Sandbox interface {`
`45`	`45`	`// EnableService makes a managed container's service available by adding the`
`46`	`46`	`// endpoint to the service load balancer and service discovery`
`47`	`47`	`EnableService() error`
`48`		`- // DisableService removes a managed contianer's endpoints from the load balancer`
	`48`	`+ // DisableService removes a managed container's endpoints from the load balancer`
`49`	`49`	`// and service discovery`
`50`	`50`	`DisableService() error`
`51`	`51`	`}`