Browse code

fix nits in comments

Signed-off-by: allencloud <allen.sun@daocloud.io>

allencloud authored on 2016/12/27 20:42:32
Showing 6 changed files
... ...
@@ -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
... ...
@@ -38,7 +38,7 @@ There are positive performance implication as a result of bypassing the Linux br
38 38
 
39 39
 - 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.
40 40
 
41
-- 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.
41
+- 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.
42 42
 
43 43
 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.
44 44
 
... ...
@@ -150,7 +150,7 @@ In the case of a host reboot, instead of needing to modify often complex network
150 150
 
151 151
 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.
152 152
 
153
-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.
153
+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.
154 154
 
155 155
 For the driver to add/delete the vlan sub-interfaces the format needs to be `-o parent interface_name.vlan_tag`.
156 156
 
... ...
@@ -62,7 +62,7 @@ type Driver interface {
62 62
 	// programming to allow the external connectivity dictated by the passed options
63 63
 	ProgramExternalConnectivity(nid, eid string, options map[string]interface{}) error
64 64
 
65
-	// RevokeExternalConnectivity aks the driver to remove any external connectivity
65
+	// RevokeExternalConnectivity asks the driver to remove any external connectivity
66 66
 	// programming that was done so far
67 67
 	RevokeExternalConnectivity(nid, eid string) error
68 68
 
... ...
@@ -72,7 +72,7 @@ type Driver interface {
72 72
 	// only invoked for the global scope driver.
73 73
 	EventNotify(event EventType, nid string, tableName string, key string, value []byte)
74 74
 
75
-	// Type returns the the type of this driver, the network type this driver manages
75
+	// Type returns the type of this driver, the network type this driver manages
76 76
 	Type() string
77 77
 
78 78
 	// IsBuiltIn returns true if it is a built-in driver
... ...
@@ -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
... ...
@@ -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
... ...
@@ -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
 }