Typo fixes in comments
Correct spelling of words in source code comments. Signed-off-by: Aaron Lehmann <aaron.lehmann@docker.com>master
							parent
							
								
									a3213ff331
								
							
						
					
					
						commit
						aa80478b64
					
				|  | @ -1,6 +1,6 @@ | ||||||
| // Package context provides several utilities for working with
 | // Package context provides several utilities for working with
 | ||||||
| // golang.org/x/net/context in http requests. Primarily, the focus is on
 | // golang.org/x/net/context in http requests. Primarily, the focus is on
 | ||||||
| // logging relevent request information but this package is not limited to
 | // logging relevant request information but this package is not limited to
 | ||||||
| // that purpose.
 | // that purpose.
 | ||||||
| //
 | //
 | ||||||
| // The easiest way to get started is to get the background context:
 | // The easiest way to get started is to get the background context:
 | ||||||
|  |  | ||||||
|  | @ -10,7 +10,7 @@ import ( | ||||||
| // WithTrace allocates a traced timing span in a new context. This allows a
 | // WithTrace allocates a traced timing span in a new context. This allows a
 | ||||||
| // caller to track the time between calling WithTrace and the returned done
 | // caller to track the time between calling WithTrace and the returned done
 | ||||||
| // function. When the done function is called, a log message is emitted with a
 | // function. When the done function is called, a log message is emitted with a
 | ||||||
| // "trace.duration" field, corresponding to the elapased time and a
 | // "trace.duration" field, corresponding to the elapsed time and a
 | ||||||
| // "trace.func" field, corresponding to the function that called WithTrace.
 | // "trace.func" field, corresponding to the function that called WithTrace.
 | ||||||
| //
 | //
 | ||||||
| // The logging keys "trace.id" and "trace.parent.id" are provided to implement
 | // The logging keys "trace.id" and "trace.parent.id" are provided to implement
 | ||||||
|  |  | ||||||
|  | @ -22,7 +22,7 @@ var ( | ||||||
| // may be easily referenced by easily  referenced by a string
 | // may be easily referenced by easily  referenced by a string
 | ||||||
| // representation of the digest as well as short representation.
 | // representation of the digest as well as short representation.
 | ||||||
| // The uniqueness of the short representation is based on other
 | // The uniqueness of the short representation is based on other
 | ||||||
| // digests in the set. If digests are ommited from this set,
 | // digests in the set. If digests are omitted from this set,
 | ||||||
| // collisions in a larger set may not be detected, therefore it
 | // collisions in a larger set may not be detected, therefore it
 | ||||||
| // is important to always do short representation lookups on
 | // is important to always do short representation lookups on
 | ||||||
| // the complete set of digests. To mitigate collisions, an
 | // the complete set of digests. To mitigate collisions, an
 | ||||||
|  |  | ||||||
|  | @ -34,7 +34,7 @@ func newSafeMetrics() *safeMetrics { | ||||||
| } | } | ||||||
| 
 | 
 | ||||||
| // httpStatusListener returns the listener for the http sink that updates the
 | // httpStatusListener returns the listener for the http sink that updates the
 | ||||||
| // relevent counters.
 | // relevant counters.
 | ||||||
| func (sm *safeMetrics) httpStatusListener() httpStatusListener { | func (sm *safeMetrics) httpStatusListener() httpStatusListener { | ||||||
| 	return &endpointMetricsHTTPStatusListener{ | 	return &endpointMetricsHTTPStatusListener{ | ||||||
| 		safeMetrics: sm, | 		safeMetrics: sm, | ||||||
|  | @ -49,7 +49,7 @@ func (sm *safeMetrics) eventQueueListener() eventQueueListener { | ||||||
| } | } | ||||||
| 
 | 
 | ||||||
| // endpointMetricsHTTPStatusListener increments counters related to http sinks
 | // endpointMetricsHTTPStatusListener increments counters related to http sinks
 | ||||||
| // for the relevent events.
 | // for the relevant events.
 | ||||||
| type endpointMetricsHTTPStatusListener struct { | type endpointMetricsHTTPStatusListener struct { | ||||||
| 	*safeMetrics | 	*safeMetrics | ||||||
| } | } | ||||||
|  |  | ||||||
|  | @ -49,7 +49,7 @@ var ( | ||||||
| 
 | 
 | ||||||
| 	// NameRegexp is the format for the name component of references. The
 | 	// NameRegexp is the format for the name component of references. The
 | ||||||
| 	// regexp has capturing groups for the hostname and name part omitting
 | 	// regexp has capturing groups for the hostname and name part omitting
 | ||||||
| 	// the seperating forward slash from either.
 | 	// the separating forward slash from either.
 | ||||||
| 	NameRegexp = expression( | 	NameRegexp = expression( | ||||||
| 		optional(hostnameRegexp, literal(`/`)), | 		optional(hostnameRegexp, literal(`/`)), | ||||||
| 		nameComponentRegexp, | 		nameComponentRegexp, | ||||||
|  |  | ||||||
|  | @ -271,7 +271,7 @@ type MethodDescriptor struct { | ||||||
| // RequestDescriptor per API use case.
 | // RequestDescriptor per API use case.
 | ||||||
| type RequestDescriptor struct { | type RequestDescriptor struct { | ||||||
| 	// Name provides a short identifier for the request, usable as a title or
 | 	// Name provides a short identifier for the request, usable as a title or
 | ||||||
| 	// to provide quick context for the particalar request.
 | 	// to provide quick context for the particular request.
 | ||||||
| 	Name string | 	Name string | ||||||
| 
 | 
 | ||||||
| 	// Description should cover the requests purpose, covering any details for
 | 	// Description should cover the requests purpose, covering any details for
 | ||||||
|  | @ -303,14 +303,14 @@ type RequestDescriptor struct { | ||||||
| // ResponseDescriptor describes the components of an API response.
 | // ResponseDescriptor describes the components of an API response.
 | ||||||
| type ResponseDescriptor struct { | type ResponseDescriptor struct { | ||||||
| 	// Name provides a short identifier for the response, usable as a title or
 | 	// Name provides a short identifier for the response, usable as a title or
 | ||||||
| 	// to provide quick context for the particalar response.
 | 	// to provide quick context for the particular response.
 | ||||||
| 	Name string | 	Name string | ||||||
| 
 | 
 | ||||||
| 	// Description should provide a brief overview of the role of the
 | 	// Description should provide a brief overview of the role of the
 | ||||||
| 	// response.
 | 	// response.
 | ||||||
| 	Description string | 	Description string | ||||||
| 
 | 
 | ||||||
| 	// StatusCode specifies the status recieved by this particular response.
 | 	// StatusCode specifies the status received by this particular response.
 | ||||||
| 	StatusCode int | 	StatusCode int | ||||||
| 
 | 
 | ||||||
| 	// Headers covers any headers that may be returned from the response.
 | 	// Headers covers any headers that may be returned from the response.
 | ||||||
|  |  | ||||||
|  | @ -84,7 +84,7 @@ var ( | ||||||
| 	}) | 	}) | ||||||
| 
 | 
 | ||||||
| 	// ErrorCodeManifestUnverified is returned when the manifest fails
 | 	// ErrorCodeManifestUnverified is returned when the manifest fails
 | ||||||
| 	// signature verfication.
 | 	// signature verification.
 | ||||||
| 	ErrorCodeManifestUnverified = errcode.Register(errGroup, errcode.ErrorDescriptor{ | 	ErrorCodeManifestUnverified = errcode.Register(errGroup, errcode.ErrorDescriptor{ | ||||||
| 		Value:   "MANIFEST_UNVERIFIED", | 		Value:   "MANIFEST_UNVERIFIED", | ||||||
| 		Message: "manifest failed signature verification", | 		Message: "manifest failed signature verification", | ||||||
|  |  | ||||||
|  | @ -1182,7 +1182,7 @@ func testManifestAPISchema2(t *testing.T, env *testEnv, imageName reference.Name | ||||||
| 	manifest.Config.Digest = sampleConfigDigest | 	manifest.Config.Digest = sampleConfigDigest | ||||||
| 	manifest.Config.Size = int64(len(sampleConfig)) | 	manifest.Config.Size = int64(len(sampleConfig)) | ||||||
| 
 | 
 | ||||||
| 	// The manifest should still be invalid, because its layer doesnt exist
 | 	// The manifest should still be invalid, because its layer doesn't exist
 | ||||||
| 	resp = putManifest(t, "putting missing layer manifest", manifestURL, schema2.MediaTypeManifest, manifest) | 	resp = putManifest(t, "putting missing layer manifest", manifestURL, schema2.MediaTypeManifest, manifest) | ||||||
| 	defer resp.Body.Close() | 	defer resp.Body.Close() | ||||||
| 	checkResponse(t, "putting missing layer manifest", resp, http.StatusBadRequest) | 	checkResponse(t, "putting missing layer manifest", resp, http.StatusBadRequest) | ||||||
|  | @ -1415,7 +1415,7 @@ func testManifestAPISchema2(t *testing.T, env *testEnv, imageName reference.Name | ||||||
| 		t.Fatal("wrong number of History entries") | 		t.Fatal("wrong number of History entries") | ||||||
| 	} | 	} | ||||||
| 
 | 
 | ||||||
| 	// Don't check V1Compatibility fields becuase we're using randomly-generated
 | 	// Don't check V1Compatibility fields because we're using randomly-generated
 | ||||||
| 	// layers.
 | 	// layers.
 | ||||||
| 
 | 
 | ||||||
| 	return args | 	return args | ||||||
|  | @ -1641,7 +1641,7 @@ func testManifestAPIManifestList(t *testing.T, env *testEnv, args manifestArgs) | ||||||
| 		t.Fatal("wrong number of History entries") | 		t.Fatal("wrong number of History entries") | ||||||
| 	} | 	} | ||||||
| 
 | 
 | ||||||
| 	// Don't check V1Compatibility fields becuase we're using randomly-generated
 | 	// Don't check V1Compatibility fields because we're using randomly-generated
 | ||||||
| 	// layers.
 | 	// layers.
 | ||||||
| } | } | ||||||
| 
 | 
 | ||||||
|  |  | ||||||
|  | @ -405,7 +405,7 @@ func (app *App) configureEvents(configuration *configuration.Configuration) { | ||||||
| 		sinks = append(sinks, endpoint) | 		sinks = append(sinks, endpoint) | ||||||
| 	} | 	} | ||||||
| 
 | 
 | ||||||
| 	// NOTE(stevvooe): Moving to a new queueing implementation is as easy as
 | 	// NOTE(stevvooe): Moving to a new queuing implementation is as easy as
 | ||||||
| 	// replacing broadcaster with a rabbitmq implementation. It's recommended
 | 	// replacing broadcaster with a rabbitmq implementation. It's recommended
 | ||||||
| 	// that the registry instances also act as the workers to keep deployment
 | 	// that the registry instances also act as the workers to keep deployment
 | ||||||
| 	// simple.
 | 	// simple.
 | ||||||
|  |  | ||||||
|  | @ -35,7 +35,7 @@ func copyFullPayload(responseWriter http.ResponseWriter, r *http.Request, destWr | ||||||
| 	// Read in the data, if any.
 | 	// Read in the data, if any.
 | ||||||
| 	copied, err := io.Copy(destWriter, r.Body) | 	copied, err := io.Copy(destWriter, r.Body) | ||||||
| 	if clientClosed != nil && (err != nil || (r.ContentLength > 0 && copied < r.ContentLength)) { | 	if clientClosed != nil && (err != nil || (r.ContentLength > 0 && copied < r.ContentLength)) { | ||||||
| 		// Didn't recieve as much content as expected. Did the client
 | 		// Didn't receive as much content as expected. Did the client
 | ||||||
| 		// disconnect during the request? If so, avoid returning a 400
 | 		// disconnect during the request? If so, avoid returning a 400
 | ||||||
| 		// error to keep the logs cleaner.
 | 		// error to keep the logs cleaner.
 | ||||||
| 		select { | 		select { | ||||||
|  |  | ||||||
|  | @ -285,7 +285,7 @@ func (d *driver) WriteStream(context ctx.Context, path string, offset int64, rea | ||||||
| 	if err != nil { | 	if err != nil { | ||||||
| 		return nn, err | 		return nn, err | ||||||
| 	} | 	} | ||||||
| 	// wc was closed succesfully, so the temporary part exists, schedule it for deletion at the end
 | 	// wc was closed successfully, so the temporary part exists, schedule it for deletion at the end
 | ||||||
| 	// of the function
 | 	// of the function
 | ||||||
| 	defer storageDeleteObject(gcsContext, d.bucket, partName) | 	defer storageDeleteObject(gcsContext, d.bucket, partName) | ||||||
| 
 | 
 | ||||||
|  |  | ||||||
|  | @ -133,7 +133,7 @@ func (err InvalidOffsetError) Error() string { | ||||||
| } | } | ||||||
| 
 | 
 | ||||||
| // Error is a catch-all error type which captures an error string and
 | // Error is a catch-all error type which captures an error string and
 | ||||||
| // the driver type on which it occured.
 | // the driver type on which it occurred.
 | ||||||
| type Error struct { | type Error struct { | ||||||
| 	DriverName string | 	DriverName string | ||||||
| 	Enclosed   error | 	Enclosed   error | ||||||
|  |  | ||||||
|  | @ -158,7 +158,7 @@ func (suite *DriverSuite) TestInvalidPaths(c *check.C) { | ||||||
| 
 | 
 | ||||||
| 	for _, filename := range invalidFiles { | 	for _, filename := range invalidFiles { | ||||||
| 		err := suite.StorageDriver.PutContent(suite.ctx, filename, contents) | 		err := suite.StorageDriver.PutContent(suite.ctx, filename, contents) | ||||||
| 		// only delete if file was succesfully written
 | 		// only delete if file was successfully written
 | ||||||
| 		if err == nil { | 		if err == nil { | ||||||
| 			defer suite.deletePath(c, firstPart(filename)) | 			defer suite.deletePath(c, firstPart(filename)) | ||||||
| 		} | 		} | ||||||
|  |  | ||||||
|  | @ -48,7 +48,7 @@ const ( | ||||||
| // The storage backend layout is broken up into a content-addressable blob
 | // The storage backend layout is broken up into a content-addressable blob
 | ||||||
| // store and repositories. The content-addressable blob store holds most data
 | // store and repositories. The content-addressable blob store holds most data
 | ||||||
| // throughout the backend, keyed by algorithm and digests of the underlying
 | // throughout the backend, keyed by algorithm and digests of the underlying
 | ||||||
| // content. Access to the blob store is controled through links from the
 | // content. Access to the blob store is controlled through links from the
 | ||||||
| // repository to blobstore.
 | // repository to blobstore.
 | ||||||
| //
 | //
 | ||||||
| // A repository is made up of layers, manifests and tags. The layers component
 | // A repository is made up of layers, manifests and tags. The layers component
 | ||||||
|  | @ -301,7 +301,7 @@ type manifestRevisionLinkPathSpec struct { | ||||||
| 
 | 
 | ||||||
| func (manifestRevisionLinkPathSpec) pathSpec() {} | func (manifestRevisionLinkPathSpec) pathSpec() {} | ||||||
| 
 | 
 | ||||||
| // manifestSignaturesPathSpec decribes the path components for the directory
 | // manifestSignaturesPathSpec describes the path components for the directory
 | ||||||
| // containing all the signatures for the target blob. Entries are named with
 | // containing all the signatures for the target blob. Entries are named with
 | ||||||
| // the underlying key id.
 | // the underlying key id.
 | ||||||
| type manifestSignaturesPathSpec struct { | type manifestSignaturesPathSpec struct { | ||||||
|  | @ -311,7 +311,7 @@ type manifestSignaturesPathSpec struct { | ||||||
| 
 | 
 | ||||||
| func (manifestSignaturesPathSpec) pathSpec() {} | func (manifestSignaturesPathSpec) pathSpec() {} | ||||||
| 
 | 
 | ||||||
| // manifestSignatureLinkPathSpec decribes the path components used to look up
 | // manifestSignatureLinkPathSpec describes the path components used to look up
 | ||||||
| // a signature file by the hash of its blob.
 | // a signature file by the hash of its blob.
 | ||||||
| type manifestSignatureLinkPathSpec struct { | type manifestSignatureLinkPathSpec struct { | ||||||
| 	name      string | 	name      string | ||||||
|  |  | ||||||
		Loading…
	
		Reference in New Issue