diff options
55 files changed, 415 insertions, 389 deletions
diff --git a/api/types/filters/parse.go b/api/types/filters/parse.go index 6a2139adb3..52c190ec79 100644 --- a/api/types/filters/parse.go +++ b/api/types/filters/parse.go @@ -1,4 +1,5 @@ -/*Package filters provides tools for encoding a mapping of keys to a set of +/* +Package filters provides tools for encoding a mapping of keys to a set of multiple values. */ package filters // import "github.com/docker/docker/api/types/filters" diff --git a/api/types/registry/registry.go b/api/types/registry/registry.go index 53e47084c8..62a88f5be8 100644 --- a/api/types/registry/registry.go +++ b/api/types/registry/registry.go @@ -45,31 +45,32 @@ func (ipnet *NetIPNet) UnmarshalJSON(b []byte) (err error) { // IndexInfo contains information about a registry // // RepositoryInfo Examples: -// { -// "Index" : { -// "Name" : "docker.io", -// "Mirrors" : ["https://registry-2.docker.io/v1/", "https://registry-3.docker.io/v1/"], -// "Secure" : true, -// "Official" : true, -// }, -// "RemoteName" : "library/debian", -// "LocalName" : "debian", -// "CanonicalName" : "docker.io/debian" -// "Official" : true, -// } // -// { -// "Index" : { -// "Name" : "127.0.0.1:5000", -// "Mirrors" : [], -// "Secure" : false, -// "Official" : false, -// }, -// "RemoteName" : "user/repo", -// "LocalName" : "127.0.0.1:5000/user/repo", -// "CanonicalName" : "127.0.0.1:5000/user/repo", -// "Official" : false, -// } +// { +// "Index" : { +// "Name" : "docker.io", +// "Mirrors" : ["https://registry-2.docker.io/v1/", "https://registry-3.docker.io/v1/"], +// "Secure" : true, +// "Official" : true, +// }, +// "RemoteName" : "library/debian", +// "LocalName" : "debian", +// "CanonicalName" : "docker.io/debian" +// "Official" : true, +// } +// +// { +// "Index" : { +// "Name" : "127.0.0.1:5000", +// "Mirrors" : [], +// "Secure" : false, +// "Official" : false, +// }, +// "RemoteName" : "user/repo", +// "LocalName" : "127.0.0.1:5000/user/repo", +// "CanonicalName" : "127.0.0.1:5000/user/repo", +// "Official" : false, +// } type IndexInfo struct { // Name is the name of the registry, such as "docker.io" Name string diff --git a/api/types/time/timestamp.go b/api/types/time/timestamp.go index ea3495efeb..2a74b7a597 100644 --- a/api/types/time/timestamp.go +++ b/api/types/time/timestamp.go @@ -100,8 +100,10 @@ func GetTimestamp(value string, reference time.Time) (string, error) { // if the incoming nanosecond portion is longer or shorter than 9 digits it is // converted to nanoseconds. The expectation is that the seconds and // seconds will be used to create a time variable. For example: -// seconds, nanoseconds, err := ParseTimestamp("1136073600.000000001",0) -// if err == nil since := time.Unix(seconds, nanoseconds) +// +// seconds, nanoseconds, err := ParseTimestamp("1136073600.000000001",0) +// if err == nil since := time.Unix(seconds, nanoseconds) +// // returns seconds as def(aultSeconds) if value == "" func ParseTimestamps(value string, def int64) (int64, int64, error) { if value == "" { diff --git a/builder/dockerfile/dispatchers.go b/builder/dockerfile/dispatchers.go index 65a3a8540c..d946db6c2b 100644 --- a/builder/dockerfile/dispatchers.go +++ b/builder/dockerfile/dispatchers.go @@ -35,7 +35,6 @@ import ( // // Sets the environment variable foo to bar, also makes interpolation // in the dockerfile available from the next statement on via ${foo}. -// func dispatchEnv(d dispatchRequest, c *instructions.EnvCommand) error { runConfig := d.state.runConfig commitMessage := bytes.NewBufferString("ENV") @@ -73,7 +72,6 @@ func dispatchMaintainer(d dispatchRequest, c *instructions.MaintainerCommand) er // LABEL some json data describing the image // // Sets the Label variable foo to bar, -// func dispatchLabel(d dispatchRequest, c *instructions.LabelCommand) error { if d.state.runConfig.Labels == nil { d.state.runConfig.Labels = make(map[string]string) @@ -90,7 +88,6 @@ func dispatchLabel(d dispatchRequest, c *instructions.LabelCommand) error { // // Add the file 'foo' to '/path'. Tarball and Remote URL (http, https) handling // exist here. If you do not wish to have this automatic handling, use COPY. -// func dispatchAdd(d dispatchRequest, c *instructions.AddCommand) error { if c.Chmod != "" { return errors.New("the --chmod option requires BuildKit. Refer to https://docs.docker.com/go/buildkit/ to learn how to build images with BuildKit enabled") @@ -112,7 +109,6 @@ func dispatchAdd(d dispatchRequest, c *instructions.AddCommand) error { // COPY foo /path // // Same as 'ADD' but without the tar and remote url handling. -// func dispatchCopy(d dispatchRequest, c *instructions.CopyCommand) error { if c.Chmod != "" { return errors.New("the --chmod option requires BuildKit. Refer to https://docs.docker.com/go/buildkit/ to learn how to build images with BuildKit enabled") @@ -157,7 +153,6 @@ func (d *dispatchRequest) getImageMount(imageRefOrID string) (*imageMount, error } // FROM [--platform=platform] imagename[:tag | @digest] [AS build-stage-name] -// func initializeStage(d dispatchRequest, cmd *instructions.Stage) error { d.builder.imageProber.Reset() @@ -290,7 +285,6 @@ func dispatchOnbuild(d dispatchRequest, c *instructions.OnbuildCommand) error { // WORKDIR /tmp // // Set the working directory for future RUN/CMD/etc statements. -// func dispatchWorkdir(d dispatchRequest, c *instructions.WorkdirCommand) error { runConfig := d.state.runConfig var err error @@ -333,7 +327,6 @@ func dispatchWorkdir(d dispatchRequest, c *instructions.WorkdirCommand) error { // RUN echo hi # sh -c echo hi (Linux and LCOW) // RUN echo hi # cmd /S /C echo hi (Windows) // RUN [ "echo", "hi" ] # echo hi -// func dispatchRun(d dispatchRequest, c *instructions.RunCommand) error { if !system.IsOSSupported(d.state.operatingSystem) { return system.ErrNotSupportedOperatingSystem @@ -428,7 +421,6 @@ func prependEnvOnCmd(buildArgs *BuildArgs, buildArgVars []string, cmd strslice.S // // Set the default command to run in the container (which may be empty). // Argument handling is the same as RUN. -// func dispatchCmd(d dispatchRequest, c *instructions.CmdCommand) error { runConfig := d.state.runConfig cmd, argsEscaped := resolveCmdLine(c.ShellDependantCmdLine, runConfig, d.state.operatingSystem, c.Name(), c.String()) @@ -459,7 +451,6 @@ func dispatchCmd(d dispatchRequest, c *instructions.CmdCommand) error { // // Set the default healthcheck command to run in the container (which may be empty). // Argument handling is the same as RUN. -// func dispatchHealthcheck(d dispatchRequest, c *instructions.HealthCheckCommand) error { runConfig := d.state.runConfig if runConfig.Healthcheck != nil { @@ -479,7 +470,6 @@ func dispatchHealthcheck(d dispatchRequest, c *instructions.HealthCheckCommand) // // Handles command processing similar to CMD and RUN, only req.runConfig.Entrypoint // is initialized at newBuilder time instead of through argument parsing. -// func dispatchEntrypoint(d dispatchRequest, c *instructions.EntrypointCommand) error { runConfig := d.state.runConfig cmd, argsEscaped := resolveCmdLine(c.ShellDependantCmdLine, runConfig, d.state.operatingSystem, c.Name(), c.String()) @@ -509,7 +499,6 @@ func dispatchEntrypoint(d dispatchRequest, c *instructions.EntrypointCommand) er // // Expose ports for links and port mappings. This all ends up in // req.runConfig.ExposedPorts for runconfig. -// func dispatchExpose(d dispatchRequest, c *instructions.ExposeCommand, envs []string) error { // custom multi word expansion // expose $FOO with FOO="80 443" is expanded as EXPOSE [80,443]. This is the only command supporting word to words expansion @@ -543,7 +532,6 @@ func dispatchExpose(d dispatchRequest, c *instructions.ExposeCommand, envs []str // // Set the user to 'foo' for future commands and when running the // ENTRYPOINT/CMD at container run time. -// func dispatchUser(d dispatchRequest, c *instructions.UserCommand) error { d.state.runConfig.User = c.User return d.builder.commit(d.state, fmt.Sprintf("USER %v", c.User)) @@ -552,7 +540,6 @@ func dispatchUser(d dispatchRequest, c *instructions.UserCommand) error { // VOLUME /foo // // Expose the volume /foo for use. Will also accept the JSON array form. -// func dispatchVolume(d dispatchRequest, c *instructions.VolumeCommand) error { if d.state.runConfig.Volumes == nil { d.state.runConfig.Volumes = map[string]struct{}{} diff --git a/builder/remotecontext/remote.go b/builder/remotecontext/remote.go index 6eeadf521d..8f09ed0997 100644 --- a/builder/remotecontext/remote.go +++ b/builder/remotecontext/remote.go @@ -80,10 +80,10 @@ func GetWithStatusError(address string) (resp *http.Response, err error) { // inspectResponse looks into the http response data at r to determine whether its // content-type is on the list of acceptable content types for remote build contexts. // This function returns: -// - a string representation of the detected content-type -// - an io.Reader for the response body -// - an error value which will be non-nil either when something goes wrong while -// reading bytes from r or when the detected content-type is not acceptable. +// - a string representation of the detected content-type +// - an io.Reader for the response body +// - an error value which will be non-nil either when something goes wrong while +// reading bytes from r or when the detected content-type is not acceptable. func inspectResponse(ct string, r io.Reader, clen int64) (string, io.Reader, error) { plen := clen if plen <= 0 || plen > maxPreambleLength { diff --git a/builder/remotecontext/urlutil/urlutil.go b/builder/remotecontext/urlutil/urlutil.go index d4078942e9..e38988a30c 100644 --- a/builder/remotecontext/urlutil/urlutil.go +++ b/builder/remotecontext/urlutil/urlutil.go @@ -30,12 +30,11 @@ func IsURL(str string) bool { // // The following patterns are considered to be a Git URL: // -// - https://(.*).git(?:#.+)?$ git repository URL with optional fragment, as -// known to be used by GitHub and GitLab. -// - http://(.*).git(?:#.+)?$ same, but non-TLS -// - git://(.*) URLs using git:// scheme -// - git@(.*) -// - github.com/ see description below +// - https://(.*).git(?:#.+)?$ git repository URL with optional fragment, as known to be used by GitHub and GitLab. +// - http://(.*).git(?:#.+)?$ same, but non-TLS +// - git://(.*) URLs using git:// scheme +// - git@(.*) +// - github.com/ see description below // // The github.com/ prefix is a special case used to treat context-paths // starting with "github.com/" as a git URL if the given path does not @@ -49,7 +48,7 @@ func IsURL(str string) bool { // path. Code using this function should check if the path exists locally before // using it as a URL. // -// Fragments +// # Fragments // // Git URLs accept context configuration in their fragment section, separated by // a colon (`:`). The first part represents the reference to check out, and can @@ -74,7 +73,6 @@ func IsURL(str string) bool { // | my-repo.git#master:directory | refs/heads/master | /directory | // | my-repo.git#mytag:directory | refs/tags/my-tag | /directory | // | my-repo.git#mybranch:directory | refs/heads/my-branch | /directory | -// func IsGitURL(str string) bool { if IsURL(str) && urlPathWithFragmentSuffix.MatchString(str) { return true diff --git a/client/client.go b/client/client.go index 1412377eab..26a0fa2756 100644 --- a/client/client.go +++ b/client/client.go @@ -4,7 +4,7 @@ Package client is a Go client for the Docker Engine API. For more information about the Engine API, see the documentation: https://docs.docker.com/engine/api/ -Usage +# Usage You use the library by creating a client object and calling methods on it. The client can be created either from environment variables with NewClientWithOpts(client.FromEnv), @@ -37,7 +37,6 @@ For example, to list running containers (the equivalent of "docker ps"): fmt.Printf("%s %s\n", container.ID[:10], container.Image) } } - */ package client // import "github.com/docker/docker/client" @@ -121,12 +120,10 @@ func CheckRedirect(req *http.Request, via []*http.Request) error { // itself with values from environment variables (client.FromEnv), and has // automatic API version negotiation enabled (client.WithAPIVersionNegotiation()). // -// // cli, err := client.NewClientWithOpts( // client.FromEnv, // client.WithAPIVersionNegotiation(), // ) -// func NewClientWithOpts(ops ...Opt) (*Client, error) { client, err := defaultHTTPClient(DefaultDockerHost) if err != nil { diff --git a/client/container_attach.go b/client/container_attach.go index 404d2a0dc5..ba92117d3e 100644 --- a/client/container_attach.go +++ b/client/container_attach.go @@ -22,7 +22,7 @@ import ( // multiplexed. // The format of the multiplexed stream is as follows: // -// [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}[]byte{OUTPUT} +// [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}[]byte{OUTPUT} // // STREAM_TYPE can be 1 for stdout and 2 for stderr // diff --git a/client/container_logs.go b/client/container_logs.go index e9ae2f680f..9bdf2b0fa6 100644 --- a/client/container_logs.go +++ b/client/container_logs.go @@ -24,7 +24,7 @@ import ( // multiplexed. // The format of the multiplexed stream is as follows: // -// [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}[]byte{OUTPUT} +// [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}[]byte{OUTPUT} // // STREAM_TYPE can be 1 for stdout and 2 for stderr // diff --git a/cmd/dockerd/daemon.go b/cmd/dockerd/daemon.go index a5ff9b6ba4..7aedbf2288 100644 --- a/cmd/dockerd/daemon.go +++ b/cmd/dockerd/daemon.go @@ -648,7 +648,7 @@ func newAPIServerConfig(config *config.Config) (*apiserver.Config, error) { // checkTLSAuthOK checks basically for an explicitly disabled TLS/TLSVerify // Going forward we do not want to support a scenario where dockerd listens -// on TCP without either TLS client auth (or an explicit opt-in to disable it) +// on TCP without either TLS client auth (or an explicit opt-in to disable it) func checkTLSAuthOK(c *config.Config) bool { if c.TLS == nil { // Either TLS is enabled by default, in which case TLS verification should be enabled by default, or explicitly disabled diff --git a/cmd/dockerd/trap/trap.go b/cmd/dockerd/trap/trap.go index fa21d99d04..3ebeaf463d 100644 --- a/cmd/dockerd/trap/trap.go +++ b/cmd/dockerd/trap/trap.go @@ -14,14 +14,13 @@ import ( // behavior expected from a vanilla unix command-line tool in general // (and the Docker engine in particular). // -// * If SIGINT or SIGTERM are received, `cleanup` is called, then the process is terminated. -// * If SIGINT or SIGTERM are received 3 times before cleanup is complete, then cleanup is -// skipped and the process is terminated immediately (allows force quit of stuck daemon) -// * A SIGQUIT always causes an exit without cleanup, with a goroutine dump preceding exit. -// * Ignore SIGPIPE events. These are generated by systemd when journald is restarted while -// the docker daemon is not restarted and also running under systemd. -// Fixes https://github.com/docker/docker/issues/19728 -// +// - If SIGINT or SIGTERM are received, `cleanup` is called, then the process is terminated. +// - If SIGINT or SIGTERM are received 3 times before cleanup is complete, then cleanup is +// skipped and the process is terminated immediately (allows force quit of stuck daemon) +// - A SIGQUIT always causes an exit without cleanup, with a goroutine dump preceding exit. +// - Ignore SIGPIPE events. These are generated by systemd when journald is restarted while +// the docker daemon is not restarted and also running under systemd. +// Fixes https://github.com/docker/docker/issues/19728 func Trap(cleanup func(), logger interface { Info(args ...interface{}) }) { diff --git a/container/container.go b/container/container.go index 5ca14523fd..dea443df8a 100644 --- a/container/container.go +++ b/container/container.go @@ -295,10 +295,11 @@ func (container *Container) SetupWorkingDirectory(rootIdentity idtools.Identity) // particular path inside the container as though you were a process in that // container. // -// NOTE: The returned path is *only* safely scoped inside the container's BaseFS -// if no component of the returned path changes (such as a component -// symlinking to a different path) between using this method and using the -// path. See symlink.FollowSymlinkInScope for more details. +// # NOTE +// The returned path is *only* safely scoped inside the container's BaseFS +// if no component of the returned path changes (such as a component +// symlinking to a different path) between using this method and using the +// path. See symlink.FollowSymlinkInScope for more details. func (container *Container) GetResourcePath(path string) (string, error) { if container.BaseFS == nil { return "", errors.New("GetResourcePath: BaseFS of container " + container.ID + " is unexpectedly nil") @@ -324,10 +325,11 @@ func (container *Container) GetResourcePath(path string) (string, error) { // Only use this method to safely access the container's `container.json` or // other metadata files. If in doubt, use container.GetResourcePath. // -// NOTE: The returned path is *only* safely scoped inside the container's root -// if no component of the returned path changes (such as a component -// symlinking to a different path) between using this method and using the -// path. See symlink.FollowSymlinkInScope for more details. +// # NOTE +// The returned path is *only* safely scoped inside the container's root +// if no component of the returned path changes (such as a component +// symlinking to a different path) between using this method and using the +// path. See symlink.FollowSymlinkInScope for more details. func (container *Container) GetRootResourcePath(path string) (string, error) { // IMPORTANT - These are paths on the OS where the daemon is running, hence // any filepath operations must be done in an OS agnostic way. diff --git a/daemon/cluster/listen_addr.go b/daemon/cluster/listen_addr.go index f33efe774a..9bbf8e42a7 100644 --- a/daemon/cluster/listen_addr.go +++ b/daemon/cluster/listen_addr.go @@ -205,9 +205,9 @@ func resolveInterfaceAddr(specifiedInterface string) (net.IP, error) { } // resolveInputIPAddr tries to resolve the IP address from the string passed as input -// - tries to match the string as an interface name, if so returns the IP address associated with it -// - on failure of previous step tries to parse the string as an IP address itself -// if succeeds returns the IP address +// - tries to match the string as an interface name, if so returns the IP address associated with it +// - on failure of previous step tries to parse the string as an IP address itself +// if succeeds returns the IP address func resolveInputIPAddr(input string, isUnspecifiedValid bool) (net.IP, error) { // Try to see if it is an interface name interfaceAddr, err := resolveInterfaceAddr(input) diff --git a/daemon/container.go b/daemon/container.go index f37ccacacd..dd752f2b44 100644 --- a/daemon/container.go +++ b/daemon/container.go @@ -27,11 +27,11 @@ import ( // GetContainer looks for a container using the provided information, which could be // one of the following inputs from the caller: -// - A full container ID, which will exact match a container in daemon's list -// - A container name, which will only exact match via the GetByName() function -// - A partial container ID prefix (e.g. short ID) of any length that is -// unique enough to only return a single container object -// If none of these searches succeed, an error is returned +// - A full container ID, which will exact match a container in daemon's list +// - A container name, which will only exact match via the GetByName() function +// - A partial container ID prefix (e.g. short ID) of any length that is +// unique enough to only return a single container object +// If none of these searches succeed, an error is returned func (daemon *Daemon) GetContainer(prefixOrName string) (*container.Container, error) { if len(prefixOrName) == 0 { return nil, errors.WithStack(invalidIdentifier(prefixOrName)) diff --git a/daemon/daemon_unix.go b/daemon/daemon_unix.go index bdba08b063..55664deac1 100644 --- a/daemon/daemon_unix.go +++ b/daemon/daemon_unix.go @@ -1077,15 +1077,16 @@ func setupInitLayer(idMapping idtools.IdentityMapping) func(containerfs.Containe } // Parse the remapped root (user namespace) option, which can be one of: -// username - valid username from /etc/passwd -// username:groupname - valid username; valid groupname from /etc/group -// uid - 32-bit unsigned int valid Linux UID value -// uid:gid - uid value; 32-bit unsigned int Linux GID value // -// If no groupname is specified, and a username is specified, an attempt -// will be made to lookup a gid for that username as a groupname +// - username - valid username from /etc/passwd +// - username:groupname - valid username; valid groupname from /etc/group +// - uid - 32-bit unsigned int valid Linux UID value +// - uid:gid - uid value; 32-bit unsigned int Linux GID value // -// If names are used, they are verified to exist in passwd/group +// If no groupname is specified, and a username is specified, an attempt +// will be made to lookup a gid for that username as a groupname +// +// If names are used, they are verified to exist in passwd/group func parseRemappedRoot(usergrp string) (string, string, error) { var ( diff --git a/daemon/graphdriver/fsdiff.go b/daemon/graphdriver/fsdiff.go index 92f34e2997..c61369535d 100644 --- a/daemon/graphdriver/fsdiff.go +++ b/daemon/graphdriver/fsdiff.go @@ -30,10 +30,11 @@ type NaiveDiffDriver struct { // NewNaiveDiffDriver returns a fully functional driver that wraps the // given ProtoDriver and adds the capability of the following methods which // it may or may not support on its own: -// Diff(id, parent string) (archive.Archive, error) -// Changes(id, parent string) ([]archive.Change, error) -// ApplyDiff(id, parent string, diff archive.Reader) (size int64, err error) -// DiffSize(id, parent string) (size int64, err error) +// +// Diff(id, parent string) (archive.Archive, error) +// Changes(id, parent string) ([]archive.Change, error) +// ApplyDiff(id, parent string, diff archive.Reader) (size int64, err error) +// DiffSize(id, parent string) (size int64, err error) func NewNaiveDiffDriver(driver ProtoDriver, idMap idtools.IdentityMapping) Driver { return &NaiveDiffDriver{ProtoDriver: driver, idMap: idMap} diff --git a/daemon/images/image.go b/daemon/images/image.go index 2dd7759900..b6a994cb9d 100644 --- a/daemon/images/image.go +++ b/daemon/images/image.go @@ -219,7 +219,7 @@ func (i *ImageService) GetImage(refOrID string, platform *specs.Platform) (retIm } // OnlyPlatformWithFallback uses `platforms.Only` with a fallback to handle the case where the platform -// being matched does not have a CPU variant. +// being matched does not have a CPU variant. // // The reason for this is that CPU variant is not even if the official image config spec as of this writing. // See: https://github.com/opencontainers/image-spec/pull/809 diff --git a/daemon/images/image_commit.go b/daemon/images/image_commit.go index 58854bdd61..dcde88adc4 100644 --- a/daemon/images/image_commit.go +++ b/daemon/images/image_commit.go @@ -104,9 +104,9 @@ func exportContainerRw(layerStore layer.Store, id, mountLabel string) (arch io.R // the build. // // This method is different from CreateImageFromContainer: -// * it doesn't attempt to validate container state -// * it doesn't send a commit action to metrics -// * it doesn't log a container commit event +// - it doesn't attempt to validate container state +// - it doesn't send a commit action to metrics +// - it doesn't log a container commit event // // This is a temporary shim. Should be removed when builder stops using commit. func (i *ImageService) CommitBuildStep(c backend.CommitConfig) (image.ID, error) { diff --git a/daemon/images/image_delete.go b/daemon/images/image_delete.go index 1c1676d585..9cad78b87c 100644 --- a/daemon/images/image_delete.go +++ b/daemon/images/image_delete.go @@ -44,13 +44,13 @@ const ( // are divided into two categories grouped by their severity: // // Hard Conflict: -// - a pull or build using the image. -// - any descendant image. -// - any running container using the image. +// - a pull or build using the image. +// - any descendant image. +// - any running container using the image. // // Soft Conflict: -// - any stopped container using the image. -// - any repository tag or digest references to the image. +// - any stopped container using the image. +// - any repository tag or digest references to the image. // // The image cannot be removed if there are any hard conflicts and can be // removed if there are soft conflicts only if force is true. @@ -58,7 +58,6 @@ const ( // If prune is true, ancestor images will each attempt to be deleted quietly, // meaning any delete conflicts will cause the image to not be deleted and the // conflict will not be reported. -// func (i *ImageService) ImageDelete(imageRef string, force, prune bool) ([]types.ImageDeleteResponseItem, error) { start := time.Now() records := []types.ImageDeleteResponseItem{} diff --git a/daemon/info_unix.go b/daemon/info_unix.go index b4ebc52a85..eb7c01cc52 100644 --- a/daemon/info_unix.go +++ b/daemon/info_unix.go @@ -306,7 +306,7 @@ func getBackingFs(v *types.Info) string { // // Output example from `docker-init --version`: // -// tini version 0.18.0 - git.fec3683 +// tini version 0.18.0 - git.fec3683 func parseInitVersion(v string) (version string, commit string, err error) { parts := strings.Split(v, " - ") @@ -331,9 +331,9 @@ func parseInitVersion(v string) (version string, commit string, err error) { // // Output example from `runc --version`: // -// runc version 1.0.0-rc5+dev -// commit: 69663f0bd4b60df09991c08812a60108003fa340 -// spec: 1.0.0 +// runc version 1.0.0-rc5+dev +// commit: 69663f0bd4b60df09991c08812a60108003fa340 +// spec: 1.0.0 func parseRuntimeVersion(v string) (runtime string, version string, commit string, err error) { lines := strings.Split(strings.TrimSpace(v), "\n") for _, line := range lines { diff --git a/daemon/top_windows.go b/daemon/top_windows.go index 010b426d3f..eaaad4f771 100644 --- a/daemon/top_windows.go +++ b/daemon/top_windows.go @@ -11,19 +11,20 @@ import ( ) // ContainerTop handles `docker top` client requests. +// // Future considerations: -// -- Windows users are far more familiar with CPU% total. -// Further, users on Windows rarely see user/kernel CPU stats split. -// The kernel returns everything in terms of 100ns. To obtain -// CPU%, we could do something like docker stats does which takes two -// samples, subtract the difference and do the maths. Unfortunately this -// would slow the stat call down and require two kernel calls. So instead, -// we do something similar to linux and display the CPU as combined HH:MM:SS.mmm. -// -- Perhaps we could add an argument to display "raw" stats -// -- "Memory" is an extremely overloaded term in Windows. Hence we do what -// task manager does and use the private working set as the memory counter. -// We could return more info for those who really understand how memory -// management works in Windows if we introduced a "raw" stats (above). +// - Windows users are far more familiar with CPU% total. +// Further, users on Windows rarely see user/kernel CPU stats split. +// The kernel returns everything in terms of 100ns. To obtain +// CPU%, we could do something like docker stats does which takes two +// samples, subtract the difference and do the maths. Unfortunately this +// would slow the stat call down and require two kernel calls. So instead, +// we do something similar to linux and display the CPU as combined HH:MM:SS.mmm. +// - Perhaps we could add an argument to display "raw" stats +// - "Memory" is an extremely overloaded term in Windows. Hence we do what +// task manager does and use the private working set as the memory counter. +// We could return more info for those who really understand how memory +// management works in Windows if we introduced a "raw" stats (above). func (daemon *Daemon) ContainerTop(name string, psArgs string) (*containertypes.ContainerTopOKBody, error) { // It's not at all an equivalent to linux 'ps' on Windows if psArgs != "" { diff --git a/dockerversion/useragent.go b/dockerversion/useragent.go index afbdcd8584..d08b391268 100644 --- a/dockerversion/useragent.go +++ b/dockerversion/useragent.go @@ -14,7 +14,8 @@ type UAStringKey struct{} // DockerUserAgent is the User-Agent the Docker client uses to identify itself. // In accordance with RFC 7231 (5.5.3) is of the form: -// [docker client's UA] UpstreamClient([upstream client's UA]) +// +// [docker client's UA] UpstreamClient([upstream client's UA]) func DockerUserAgent(ctx context.Context) string { httpVersion := make([]useragent.VersionInfo, 0, 6) httpVersion = append(httpVersion, useragent.VersionInfo{Name: "docker", Version: Version}) @@ -68,7 +69,8 @@ func escapeStr(s string, charsToEscape string) string { // insertUpstreamUserAgent adds the upstream client useragent to create a user-agent // string of the form: -// $dockerUA UpstreamClient($upstreamUA) +// +// $dockerUA UpstreamClient($upstreamUA) func insertUpstreamUserAgent(upstreamUA string, dockerUA string) string { charsToEscape := `();\` upstreamUAEscaped := escapeStr(upstreamUA, charsToEscape) diff --git a/integration-cli/docker_cli_cp_from_container_test.go b/integration-cli/docker_cli_cp_from_container_test.go index 3b309ee7f6..997655cfe5 100644 --- a/integration-cli/docker_cli_cp_from_container_test.go +++ b/integration-cli/docker_cli_cp_from_container_test.go @@ -93,9 +93,10 @@ func (s *DockerCLICpSuite) TestCpFromSymlinkDestination(c *testing.T) { // J | yes | yes | yes | yes | - | copy dir contents // -// A. SRC specifies a file and DST (no trailing path separator) doesn't -// exist. This should create a file with the name DST and copy the -// contents of the source file into it. +// A. SRC specifies a file and DST (no trailing path separator) doesn't exist. +// +// This should create a file with the name DST and copy the contents of the +// source file into it. func (s *DockerCLICpSuite) TestCpFromCaseA(c *testing.T) { testRequires(c, DaemonIsLinux) containerID := makeTestContainer(c, testContainerOptions{ @@ -112,9 +113,10 @@ func (s *DockerCLICpSuite) TestCpFromCaseA(c *testing.T) { assert.NilError(c, fileContentEquals(c, dstPath, "file1\n")) } -// B. SRC specifies a file and DST (with trailing path separator) doesn't -// exist. This should cause an error because the copy operation cannot -// create a directory when copying a single file. +// B. SRC specifies a file and DST (with trailing path separator) doesn't exist. +// +// This should cause an error because the copy operation cannot create a directory +// when copying a single file. func (s *DockerCLICpSuite) TestCpFromCaseB(c *testing.T) { testRequires(c, DaemonIsLinux) containerID := makeTestContainer(c, testContainerOptions{addContent: true}) @@ -130,8 +132,9 @@ func (s *DockerCLICpSuite) TestCpFromCaseB(c *testing.T) { assert.Assert(c, isCpDirNotExist(err), "expected DirNotExists error, but got %T: %s", err, err) } -// C. SRC specifies a file and DST exists as a file. This should overwrite -// the file at DST with the contents of the source file. +// C. SRC specifies a file and DST exists as a file. +// +// This should overwrite the file at DST with the contents of the source file. func (s *DockerCLICpSuite) TestCpFromCaseC(c *testing.T) { testRequires(c, DaemonIsLinux) containerID := makeTestContainer(c, testContainerOptions{ @@ -152,9 +155,10 @@ func (s *DockerCLICpSuite) TestCpFromCaseC(c *testing.T) { assert.NilError(c, fileContentEquals(c, dstPath, "file1\n")) } -// D. SRC specifies a file and DST exists as a directory. This should place -// a copy of the source file inside it using the basename from SRC. Ensure -// this works whether DST has a trailing path separator or not. +// D. SRC specifies a file and DST exists as a directory. +// +// This should place a copy of the source file inside it using the basename from +// SRC. Ensure this works whether DST has a trailing path separator or not. func (s *DockerCLICpSuite) TestCpFromCaseD(c *testing.T) { testRequires(c, DaemonIsLinux) containerID := makeTestContainer(c, testContainerOptions{addContent: true}) @@ -186,10 +190,11 @@ func (s *DockerCLICpSuite) TestCpFromCaseD(c *testing.T) { assert.NilError(c, fileContentEquals(c, dstPath, "file1\n")) } -// E. SRC specifies a directory and DST does not exist. This should create a -// directory at DST and copy the contents of the SRC directory into the DST -// directory. Ensure this works whether DST has a trailing path separator or -// not. +// E. SRC specifies a directory and DST does not exist. +// +// This should create a directory at DST and copy the contents of the SRC directory +// into the DST directory. Ensure this works whether DST has a trailing path +// separator or not. func (s *DockerCLICpSuite) TestCpFromCaseE(c *testing.T) { testRequires(c, DaemonIsLinux) containerID := makeTestContainer(c, testContainerOptions{addContent: true}) @@ -214,8 +219,10 @@ func (s *DockerCLICpSuite) TestCpFromCaseE(c *testing.T) { assert.NilError(c, fileContentEquals(c, dstPath, "file1-1\n")) } -// F. SRC specifies a directory and DST exists as a file. This should cause an -// error as it is not possible to overwrite a file with a directory. +// F. SRC specifies a directory and DST exists as a file. +// +// This should cause an error as it is not possible to overwrite a file with a +// directory. func (s *DockerCLICpSuite) TestCpFromCaseF(c *testing.T) { testRequires(c, DaemonIsLinux) containerID := makeTestContainer(c, testContainerOptions{ @@ -235,9 +242,10 @@ func (s *DockerCLICpSuite) TestCpFromCaseF(c *testing.T) { assert.Assert(c, isCpCannotCopyDir(err), "expected ErrCannotCopyDir error, but got %T: %s", err, err) } -// G. SRC specifies a directory and DST exists as a directory. This should copy -// the SRC directory and all its contents to the DST directory. Ensure this -// works whether DST has a trailing path separator or not. +// G. SRC specifies a directory and DST exists as a directory. +// +// This should copy the SRC directory and all its contents to the DST directory. +// Ensure this works whether DST has a trailing path separator or not. func (s *DockerCLICpSuite) TestCpFromCaseG(c *testing.T) { testRequires(c, DaemonIsLinux) containerID := makeTestContainer(c, testContainerOptions{ @@ -268,10 +276,11 @@ func (s *DockerCLICpSuite) TestCpFromCaseG(c *testing.T) { assert.NilError(c, fileContentEquals(c, dstPath, "file1-1\n")) } -// H. SRC specifies a directory's contents only and DST does not exist. This -// should create a directory at DST and copy the contents of the SRC -// directory (but not the directory itself) into the DST directory. Ensure -// this works whether DST has a trailing path separator or not. +// H. SRC specifies a directory's contents only and DST does not exist. +// +// This should create a directory at DST and copy the contents of the SRC +// directory (but not the directory itself) into the DST directory. Ensure +// this works whether DST has a trailing path separator or not. func (s *DockerCLICpSuite) TestCpFromCaseH(c *testing.T) { testRequires(c, DaemonIsLinux) containerID := makeTestContainer(c, testContainerOptions{addContent: true}) @@ -296,9 +305,10 @@ func (s *DockerCLICpSuite) TestCpFromCaseH(c *testing.T) { assert.NilError(c, fileContentEquals(c, dstPath, "file1-1\n")) } -// I. SRC specifies a directory's contents only and DST exists as a file. This -// should cause an error as it is not possible to overwrite a file with a -// directory. +// I. SRC specifies a directory's contents only and DST exists as a file. +// +// This should cause an error as it is not possible to overwrite a file with a +// directory. func (s *DockerCLICpSuite) TestCpFromCaseI(c *testing.T) { testRequires(c, DaemonIsLinux) containerID := makeTestContainer(c, testContainerOptions{ @@ -319,9 +329,10 @@ func (s *DockerCLICpSuite) TestCpFromCaseI(c *testing.T) { } // J. SRC specifies a directory's contents only and DST exists as a directory. -// This should copy the contents of the SRC directory (but not the directory -// itself) into the DST directory. Ensure this works whether DST has a -// trailing path separator or not. +// +// This should copy the contents of the SRC directory (but not the directory +// itself) into the DST directory. Ensure this works whether DST has a +// trailing path separator or not. func (s *DockerCLICpSuite) TestCpFromCaseJ(c *testing.T) { testRequires(c, DaemonIsLinux) containerID := makeTestContainer(c, testContainerOptions{ diff --git a/integration-cli/docker_cli_cp_to_container_test.go b/integration-cli/docker_cli_cp_to_container_test.go index c15a545f9a..fb22b68a74 100644 --- a/integration-cli/docker_cli_cp_to_container_test.go +++ b/integration-cli/docker_cli_cp_to_container_test.go @@ -97,9 +97,10 @@ func (s *DockerCLICpSuite) TestCpToSymlinkDestination(c *testing.T) { // J | yes | yes | yes | yes | - | copy dir contents // -// A. SRC specifies a file and DST (no trailing path separator) doesn't -// exist. This should create a file with the name DST and copy the -// contents of the source file into it. +// A. SRC specifies a file and DST (no trailing path separator) doesn't exist. +// +// This should create a file with the name DST and copy the contents of the +// source file into it. func (s *DockerCLICpSuite) TestCpToCaseA(c *testing.T) { containerID := makeTestContainer(c, testContainerOptions{ workDir: "/root", command: makeCatFileCommand("itWorks.txt"), @@ -117,9 +118,10 @@ func (s *DockerCLICpSuite) TestCpToCaseA(c *testing.T) { assert.NilError(c, containerStartOutputEquals(c, containerID, "file1\n")) } -// B. SRC specifies a file and DST (with trailing path separator) doesn't -// exist. This should cause an error because the copy operation cannot -// create a directory when copying a single file. +// B. SRC specifies a file and DST (with trailing path separator) doesn't exist. +// +// This should cause an error because the copy operation cannot create a +// directory when copying a single file. func (s *DockerCLICpSuite) TestCpToCaseB(c *testing.T) { containerID := makeTestContainer(c, testContainerOptions{ command: makeCatFileCommand("testDir/file1"), @@ -138,8 +140,9 @@ func (s *DockerCLICpSuite) TestCpToCaseB(c *testing.T) { assert.Assert(c, isCpDirNotExist(err), "expected DirNotExists error, but got %T: %s", err, err) } -// C. SRC specifies a file and DST exists as a file. This should overwrite -// the file at DST with the contents of the source file. +// C. SRC specifies a file and DST exists as a file. +// +// This should overwrite the file at DST with the contents of the source file. func (s *DockerCLICpSuite) TestCpToCaseC(c *testing.T) { testRequires(c, DaemonIsLinux) containerID := makeTestContainer(c, testContainerOptions{ @@ -161,9 +164,10 @@ func (s *DockerCLICpSuite) TestCpToCaseC(c *testing.T) { assert.NilError(c, containerStartOutputEquals(c, containerID, "file1\n"), "Should now contain file1's contents") } -// D. SRC specifies a file and DST exists as a directory. This should place -// a copy of the source file inside it using the basename from SRC. Ensure -// this works whether DST has a trailing path separator or not. +// D. SRC specifies a file and DST exists as a directory. +// +// This should place a copy of the source file inside it using the basename from +// SRC. Ensure this works whether DST has a trailing path separator or not. func (s *DockerCLICpSuite) TestCpToCaseD(c *testing.T) { testRequires(c, DaemonIsLinux) containerID := makeTestContainer(c, testContainerOptions{ @@ -198,10 +202,11 @@ func (s *DockerCLICpSuite) TestCpToCaseD(c *testing.T) { assert.NilError(c, containerStartOutputEquals(c, containerID, "file1\n"), "Should now contain file1's contents") } -// E. SRC specifies a directory and DST does not exist. This should create a -// directory at DST and copy the contents of the SRC directory into the DST -// directory. Ensure this works whether DST has a trailing path separator or -// not. +// E. SRC specifies a directory and DST does not exist. +// +// This should create a directory at DST and copy the contents of the SRC +// directory into the DST directory. Ensure this works whether DST has a +// trailing path separator or not. func (s *DockerCLICpSuite) TestCpToCaseE(c *testing.T) { containerID := makeTestContainer(c, testContainerOptions{ command: makeCatFileCommand("/testDir/file1-1"), @@ -231,8 +236,10 @@ func (s *DockerCLICpSuite) TestCpToCaseE(c *testing.T) { assert.NilError(c, containerStartOutputEquals(c, containerID, "file1-1\n"), "Should now contain file1-1's contents") } -// F. SRC specifies a directory and DST exists as a file. This should cause an -// error as it is not possible to overwrite a file with a directory. +// F. SRC specifies a directory and DST exists as a file. +// +// This should cause an error as it is not possible to overwrite a file with a +// directory. func (s *DockerCLICpSuite) TestCpToCaseF(c *testing.T) { testRequires(c, DaemonIsLinux) containerID := makeTestContainer(c, testContainerOptions{ @@ -252,9 +259,10 @@ func (s *DockerCLICpSuite) TestCpToCaseF(c *testing.T) { assert.Assert(c, isCpCannotCopyDir(err), "expected ErrCannotCopyDir error, but got %T: %s", err, err) } -// G. SRC specifies a directory and DST exists as a directory. This should copy -// the SRC directory and all its contents to the DST directory. Ensure this -// works whether DST has a trailing path separator or not. +// G. SRC specifies a directory and DST exists as a directory. +// +// This should copy the SRC directory and all its contents to the DST directory. +// Ensure this works whether DST has a trailing path separator or not. func (s *DockerCLICpSuite) TestCpToCaseG(c *testing.T) { testRequires(c, DaemonIsLinux) containerID := makeTestContainer(c, testContainerOptions{ @@ -289,10 +297,11 @@ func (s *DockerCLICpSuite) TestCpToCaseG(c *testing.T) { assert.NilError(c, containerStartOutputEquals(c, containerID, "file1-1\n"), "Should now contain file1-1's contents") } -// H. SRC specifies a directory's contents only and DST does not exist. This -// should create a directory at DST and copy the contents of the SRC -// directory (but not the directory itself) into the DST directory. Ensure -// this works whether DST has a trailing path separator or not. +// H. SRC specifies a directory's contents only and DST does not exist. +// +// This should create a directory at DST and copy the contents of the SRC +// directory (but not the directory itself) into the DST directory. Ensure +// this works whether DST has a trailing path separator or not. func (s *DockerCLICpSuite) TestCpToCaseH(c *testing.T) { containerID := makeTestContainer(c, testContainerOptions{ command: makeCatFileCommand("/testDir/file1-1"), @@ -322,9 +331,10 @@ func (s *DockerCLICpSuite) TestCpToCaseH(c *testing.T) { assert.NilError(c, containerStartOutputEquals(c, containerID, "file1-1\n"), "Should now contain file1-1's contents") } -// I. SRC specifies a directory's contents only and DST exists as a file. This -// should cause an error as it is not possible to overwrite a file with a -// directory. +// I. SRC specifies a directory's contents only and DST exists as a file. +// +// This should cause an error as it is not possible to overwrite a file with a +// directory. func (s *DockerCLICpSuite) TestCpToCaseI(c *testing.T) { testRequires(c, DaemonIsLinux) containerID := makeTestContainer(c, testContainerOptions{ @@ -345,9 +355,10 @@ func (s *DockerCLICpSuite) TestCpToCaseI(c *testing.T) { } // J. SRC specifies a directory's contents only and DST exists as a directory. -// This should copy the contents of the SRC directory (but not the directory -// itself) into the DST directory. Ensure this works whether DST has a -// trailing path separator or not. +// +// This should copy the contents of the SRC directory (but not the directory +// itself) into the DST directory. Ensure this works whether DST has a +// trailing path separator or not. func (s *DockerCLICpSuite) TestCpToCaseJ(c *testing.T) { testRequires(c, DaemonIsLinux) containerID := makeTestContainer(c, testContainerOptions{ diff --git a/integration-cli/docker_cli_external_volume_driver_test.go b/integration-cli/docker_cli_external_volume_driver_test.go index b5d229d4e5..46a5555e57 100644 --- a/integration-cli/docker_cli_external_volume_driver_test.go +++ b/integration-cli/docker_cli_external_volume_driver_test.go @@ -506,8 +506,7 @@ func (s *DockerExternalVolumeSuite) TestExternalVolumeDriverGetEmptyResponse(c * // Ensure only cached paths are used in volume list to prevent N+1 calls to `VolumeDriver.Path` // -// TODO(@cpuguy83): This test is testing internal implementation. In all the cases here, there may not even be a path -// available because the volume is not even mounted. Consider removing this test. +// TODO(@cpuguy83): This test is testing internal implementation. In all the cases here, there may not even be a path available because the volume is not even mounted. Consider removing this test. func (s *DockerExternalVolumeSuite) TestExternalVolumeDriverPathCalls(c *testing.T) { s.d.Start(c) assert.Equal(c, s.ec.paths, 0) diff --git a/integration/container/ipcmode_linux_test.go b/integration/container/ipcmode_linux_test.go index 86b60e5f5b..49141ce58e 100644 --- a/integration/container/ipcmode_linux_test.go +++ b/integration/container/ipcmode_linux_test.go @@ -26,9 +26,9 @@ import ( // // The format of /proc/self/mountinfo is like: // -// 29 23 0:24 / /dev/shm rw,nosuid,nodev shared:4 - tmpfs tmpfs rw -// ^^^^\ -// - this is the minor:major we look for +// 29 23 0:24 / /dev/shm rw,nosuid,nodev shared:4 - tmpfs tmpfs rw +// ^^^^\ +// - this is the minor:major we look for func testIpcCheckDevExists(mm string) (bool, error) { f, err := os.Open("/proc/self/mountinfo") if err != nil { diff --git a/integration/internal/container/exec.go b/integration/internal/container/exec.go index 98e2a6c481..14e370e714 100644 --- a/integration/internal/container/exec.go +++ b/integration/internal/container/exec.go @@ -33,8 +33,8 @@ func (res *ExecResult) Combined() string { // Exec executes a command inside a container, returning the result // containing stdout, stderr, and exit code. Note: -// - this is a synchronous operation; -// - cmd stdin is closed. +// - this is a synchronous operation; +// - cmd stdin is closed. func Exec(ctx context.Context, cli client.APIClient, id string, cmd []string, ops ...func(*types.ExecConfig)) (ExecResult, error) { // prepare exec execConfig := types.ExecConfig{ diff --git a/integration/service/create_test.go b/integration/service/create_test.go index 8335f894b8..0cba172d7d 100644 --- a/integration/service/create_test.go +++ b/integration/service/create_test.go @@ -363,7 +363,7 @@ func TestCreateServiceConfigFileMode(t *testing.T) { // // To test this, we're going to create a service with the sysctl option // -// {"net.ipv4.ip_nonlocal_bind": "0"} +// {"net.ipv4.ip_nonlocal_bind": "0"} // // We'll get the service's tasks to get the container ID, and then we'll // inspect the container. If the output of the container inspect contains the @@ -458,7 +458,7 @@ func TestCreateServiceSysctls(t *testing.T) { // // To test this, we're going to create a service with the capabilities option // -// []string{"CAP_NET_RAW", "CAP_SYS_CHROOT"} +// []string{"CAP_NET_RAW", "CAP_SYS_CHROOT"} // // We'll get the service's tasks to get the container ID, and then we'll // inspect the container. If the output of the container inspect contains the diff --git a/integration/system/cgroupdriver_systemd_test.go b/integration/system/cgroupdriver_systemd_test.go index c1b998abae..4544edffc9 100644 --- a/integration/system/cgroupdriver_systemd_test.go +++ b/integration/system/cgroupdriver_systemd_test.go @@ -26,7 +26,7 @@ func hasSystemd() bool { // TestCgroupDriverSystemdMemoryLimit checks that container // memory limit can be set when using systemd cgroupdriver. -// https://github.com/moby/moby/issues/35123 +// https://github.com/moby/moby/issues/35123 func TestCgroupDriverSystemdMemoryLimit(t *testing.T) { skip.If(t, testEnv.DaemonInfo.OSType == "windows") skip.If(t, !hasSystemd()) diff --git a/libcontainerd/local/local_windows.go b/libcontainerd/local/local_windows.go index 2aafa58ba7..5cd075d51e 100644 --- a/libcontainerd/local/local_windows.go +++ b/libcontainerd/local/local_windows.go @@ -102,43 +102,43 @@ func (c *client) Version(ctx context.Context) (containerd.Version, error) { // // Isolation=Process example: // -// { -// "SystemType": "Container", -// "Name": "5e0055c814a6005b8e57ac59f9a522066e0af12b48b3c26a9416e23907698776", -// "Owner": "docker", -// "VolumePath": "\\\\\\\\?\\\\Volume{66d1ef4c-7a00-11e6-8948-00155ddbef9d}", -// "IgnoreFlushesDuringBoot": true, -// "LayerFolderPath": "C:\\\\control\\\\windowsfilter\\\\5e0055c814a6005b8e57ac59f9a522066e0af12b48b3c26a9416e23907698776", -// "Layers": [{ -// "ID": "18955d65-d45a-557b-bf1c-49d6dfefc526", -// "Path": "C:\\\\control\\\\windowsfilter\\\\65bf96e5760a09edf1790cb229e2dfb2dbd0fcdc0bf7451bae099106bfbfea0c" -// }], -// "HostName": "5e0055c814a6", -// "MappedDirectories": [], -// "HvPartition": false, -// "EndpointList": ["eef2649d-bb17-4d53-9937-295a8efe6f2c"], -// } +// { +// "SystemType": "Container", +// "Name": "5e0055c814a6005b8e57ac59f9a522066e0af12b48b3c26a9416e23907698776", +// "Owner": "docker", +// "VolumePath": "\\\\\\\\?\\\\Volume{66d1ef4c-7a00-11e6-8948-00155ddbef9d}", +// "IgnoreFlushesDuringBoot": true, +// "LayerFolderPath": "C:\\\\control\\\\windowsfilter\\\\5e0055c814a6005b8e57ac59f9a522066e0af12b48b3c26a9416e23907698776", +// "Layers": [{ +// "ID": "18955d65-d45a-557b-bf1c-49d6dfefc526", +// "Path": "C:\\\\control\\\\windowsfilter\\\\65bf96e5760a09edf1790cb229e2dfb2dbd0fcdc0bf7451bae099106bfbfea0c" +// }], +// "HostName": "5e0055c814a6", +// "MappedDirectories": [], +// "HvPartition": false, +// "EndpointList": ["eef2649d-bb17-4d53-9937-295a8efe6f2c"], +// } // // Isolation=Hyper-V example: // -// { -// "SystemType": "Container", -// "Name": "475c2c58933b72687a88a441e7e0ca4bd72d76413c5f9d5031fee83b98f6045d", -// "Owner": "docker", -// "IgnoreFlushesDuringBoot": true, -// "Layers": [{ -// "ID": "18955d65-d45a-557b-bf1c-49d6dfefc526", -// "Path": "C:\\\\control\\\\windowsfilter\\\\65bf96e5760a09edf1790cb229e2dfb2dbd0fcdc0bf7451bae099106bfbfea0c" -// }], -// "HostName": "475c2c58933b", -// "MappedDirectories": [], -// "HvPartition": true, -// "EndpointList": ["e1bb1e61-d56f-405e-b75d-fd520cefa0cb"], -// "DNSSearchList": "a.com,b.com,c.com", -// "HvRuntime": { -// "ImagePath": "C:\\\\control\\\\windowsfilter\\\\65bf96e5760a09edf1790cb229e2dfb2dbd0fcdc0bf7451bae099106bfbfea0c\\\\UtilityVM" -// }, -// } +// { +// "SystemType": "Container", +// "Name": "475c2c58933b72687a88a441e7e0ca4bd72d76413c5f9d5031fee83b98f6045d", +// "Owner": "docker", +// "IgnoreFlushesDuringBoot": true, +// "Layers": [{ +// "ID": "18955d65-d45a-557b-bf1c-49d6dfefc526", +// "Path": "C:\\\\control\\\\windowsfilter\\\\65bf96e5760a09edf1790cb229e2dfb2dbd0fcdc0bf7451bae099106bfbfea0c" +// }], +// "HostName": "475c2c58933b", +// "MappedDirectories": [], +// "HvPartition": true, +// "EndpointList": ["e1bb1e61-d56f-405e-b75d-fd520cefa0cb"], +// "DNSSearchList": "a.com,b.com,c.com", +// "HvRuntime": { +// "ImagePath": "C:\\\\control\\\\windowsfilter\\\\65bf96e5760a09edf1790cb229e2dfb2dbd0fcdc0bf7451bae099106bfbfea0c\\\\UtilityVM" +// }, +// } func (c *client) Create(_ context.Context, id string, spec *specs.Spec, shim string, runtimeOptions interface{}, opts ...containerd.NewContainerOpts) error { if ctr := c.getContainer(id); ctr != nil { return errors.WithStack(errdefs.Conflict(errors.New("id already in use"))) diff --git a/libnetwork/bitseq/sequence.go b/libnetwork/bitseq/sequence.go index b53721d212..0b772aeda4 100644 --- a/libnetwork/bitseq/sequence.go +++ b/libnetwork/bitseq/sequence.go @@ -617,13 +617,14 @@ func findSequence(head *sequence, bytePos uint64) (*sequence, *sequence, uint64, // Remove current sequence if empty. // Check if new sequence can be merged with neighbour (previous/next) sequences. // -// // Identify "current" sequence containing block: -// [prev seq] [current seq] [next seq] +// +// [prev seq] [current seq] [next seq] // // Based on block position, resulting list of sequences can be any of three forms: // -// block position Resulting list of sequences +// block position Resulting list of sequences +// // A) block is first in current: [prev seq] [new] [modified current seq] [next seq] // B) block is last in current: [prev seq] [modified current seq] [new] [next seq] // C) block is in the middle of current: [prev seq] [curr pre] [new] [curr post] [next seq] diff --git a/libnetwork/datastore/datastore.go b/libnetwork/datastore/datastore.go index 0cdef6e909..e88badc0c3 100644 --- a/libnetwork/datastore/datastore.go +++ b/libnetwork/datastore/datastore.go @@ -14,7 +14,7 @@ import ( "github.com/docker/libkv/store" ) -//DataStore exported +// DataStore exported type DataStore interface { // GetObject gets data from datastore and unmarshals to the specified object GetObject(key string, o KVObject) error @@ -174,14 +174,14 @@ func (cfg *ScopeCfg) IsValid() bool { return true } -//Key provides convenient method to create a Key +// Key provides convenient method to create a Key func Key(key ...string) string { keychain := append(rootChain, key...) str := strings.Join(keychain, "/") return str + "/" } -//ParseKey provides convenient method to unpack the key to complement the Key function +// ParseKey provides convenient method to unpack the key to complement the Key function func ParseKey(key string) ([]string, error) { chain := strings.Split(strings.Trim(key, "/"), "/") diff --git a/libnetwork/drivers/bridge/setup_bridgenetfiltering.go b/libnetwork/drivers/bridge/setup_bridgenetfiltering.go index 755a00a779..deac249727 100644 --- a/libnetwork/drivers/bridge/setup_bridgenetfiltering.go +++ b/libnetwork/drivers/bridge/setup_bridgenetfiltering.go @@ -22,7 +22,7 @@ const ( ipvboth ) -//Gets the IP version in use ( [ipv4], [ipv6] or [ipv4 and ipv6] ) +// getIPVersion gets the IP version in use ( [ipv4], [ipv6] or [ipv4 and ipv6] ) func getIPVersion(config *networkConfiguration) ipVersion { ipVersion := ipv4 if config.AddressIPv6 != nil || config.EnableIPv6 { @@ -51,7 +51,7 @@ func setupBridgeNetFiltering(config *networkConfiguration, i *bridgeInterface) e return nil } -//Enable bridge net filtering if ip forwarding is enabled. See github issue #11404 +// Enable bridge net filtering if ip forwarding is enabled. See github issue #11404 func checkBridgeNetFiltering(config *networkConfiguration, i *bridgeInterface) error { ipVer := getIPVersion(config) iface := config.BridgeName @@ -121,7 +121,7 @@ func getBridgeNFKernelParam(ipVer ipVersion) string { } } -//Gets the value of the kernel parameters located at the given path +// Gets the value of the kernel parameters located at the given path func getKernelBoolParam(path string) (bool, error) { enabled := false line, err := os.ReadFile(path) @@ -134,7 +134,7 @@ func getKernelBoolParam(path string) (bool, error) { return enabled, err } -//Sets the value of the kernel parameter located at the given path +// Sets the value of the kernel parameter located at the given path func setKernelBoolParam(path string, on bool) error { value := byte('0') if on { @@ -143,7 +143,7 @@ func setKernelBoolParam(path string, on bool) error { return os.WriteFile(path, []byte{value, '\n'}, 0644) } -//Checks to see if packet forwarding is enabled +// Checks to see if packet forwarding is enabled func isPacketForwardingEnabled(ipVer ipVersion, iface string) (bool, error) { switch ipVer { case ipv4, ipv6: diff --git a/libnetwork/ipams/remote/api/api.go b/libnetwork/ipams/remote/api/api.go index b78f6c5a28..c84d604af1 100644 --- a/libnetwork/ipams/remote/api/api.go +++ b/libnetwork/ipams/remote/api/api.go @@ -34,14 +34,14 @@ func (capRes GetCapabilityResponse) ToCapability() *ipamapi.Capability { } } -// GetAddressSpacesResponse is the response to the ``get default address spaces`` request message +// GetAddressSpacesResponse is the response to the “get default address spaces“ request message type GetAddressSpacesResponse struct { Response LocalDefaultAddressSpace string GlobalDefaultAddressSpace string } -// RequestPoolRequest represents the expected data in a ``request address pool`` request message +// RequestPoolRequest represents the expected data in a “request address pool“ request message type RequestPoolRequest struct { AddressSpace string Pool string @@ -50,7 +50,7 @@ type RequestPoolRequest struct { V6 bool } -// RequestPoolResponse represents the response message to a ``request address pool`` request +// RequestPoolResponse represents the response message to a “request address pool“ request type RequestPoolResponse struct { Response PoolID string @@ -58,37 +58,37 @@ type RequestPoolResponse struct { Data map[string]string } -// ReleasePoolRequest represents the expected data in a ``release address pool`` request message +// ReleasePoolRequest represents the expected data in a “release address pool“ request message type ReleasePoolRequest struct { PoolID string } -// ReleasePoolResponse represents the response message to a ``release address pool`` request +// ReleasePoolResponse represents the response message to a “release address pool“ request type ReleasePoolResponse struct { Response } -// RequestAddressRequest represents the expected data in a ``request address`` request message +// RequestAddressRequest represents the expected data in a “request address“ request message type RequestAddressRequest struct { PoolID string Address string Options map[string]string } -// RequestAddressResponse represents the expected data in the response message to a ``request address`` request +// RequestAddressResponse represents the expected data in the response message to a “request address“ request type RequestAddressResponse struct { Response Address string // in CIDR format Data map[string]string } -// ReleaseAddressRequest represents the expected data in a ``release address`` request message +// ReleaseAddressRequest represents the expected data in a “release address“ request message type ReleaseAddressRequest struct { PoolID string Address string } -// ReleaseAddressResponse represents the response message to a ``release address`` request +// ReleaseAddressResponse represents the response message to a “release address“ request type ReleaseAddressResponse struct { Response } diff --git a/libnetwork/network.go b/libnetwork/network.go index a063d2c3ee..0b1f20f43e 100644 --- a/libnetwork/network.go +++ b/libnetwork/network.go @@ -978,13 +978,13 @@ func (n *network) Delete(options ...NetworkDeleteOption) error { } // This function gets called in 3 ways: -// * Delete() -- (false, false) -// remove if endpoint count == 0 or endpoint count == 1 and -// there is a load balancer IP -// * Delete(libnetwork.NetworkDeleteOptionRemoveLB) -- (false, true) -// remove load balancer and network if endpoint count == 1 -// * controller.networkCleanup() -- (true, true) -// remove the network no matter what +// - Delete() -- (false, false) +// remove if endpoint count == 0 or endpoint count == 1 and +// there is a load balancer IP +// - Delete(libnetwork.NetworkDeleteOptionRemoveLB) -- (false, true) +// remove load balancer and network if endpoint count == 1 +// - controller.networkCleanup() -- (true, true) +// remove the network no matter what func (n *network) delete(force bool, rmLBEndpoint bool) error { n.Lock() c := n.ctrlr diff --git a/libnetwork/networkdb/networkdb.go b/libnetwork/networkdb/networkdb.go index 80913e9be7..bb1fdc1501 100644 --- a/libnetwork/networkdb/networkdb.go +++ b/libnetwork/networkdb/networkdb.go @@ -483,17 +483,18 @@ func (nDB *NetworkDB) deleteNodeFromNetworks(deletedNode string) { // deleteNodeNetworkEntries is called in 2 conditions with 2 different outcomes: // 1) when a notification is coming of a node leaving the network -// - Walk all the network entries and mark the leaving node's entries for deletion -// These will be garbage collected when the reap timer will expire +// - Walk all the network entries and mark the leaving node's entries for deletion +// These will be garbage collected when the reap timer will expire +// // 2) when the local node is leaving the network -// - Walk all the network entries: -// A) if the entry is owned by the local node -// then we will mark it for deletion. This will ensure that if a node did not -// yet received the notification that the local node is leaving, will be aware -// of the entries to be deleted. -// B) if the entry is owned by a remote node, then we can safely delete it. This -// ensures that if we join back this network as we receive the CREATE event for -// entries owned by remote nodes, we will accept them and we notify the application +// - Walk all the network entries: +// A) if the entry is owned by the local node +// then we will mark it for deletion. This will ensure that if a node did not +// yet received the notification that the local node is leaving, will be aware +// of the entries to be deleted. +// B) if the entry is owned by a remote node, then we can safely delete it. This +// ensures that if we join back this network as we receive the CREATE event for +// entries owned by remote nodes, we will accept them and we notify the application func (nDB *NetworkDB) deleteNodeNetworkEntries(nid, node string) { // Indicates if the delete is triggered for the local node isNodeLocal := node == nDB.config.NodeID diff --git a/libnetwork/resolvconf/resolvconf.go b/libnetwork/resolvconf/resolvconf.go index a9d8027886..535c8705ba 100644 --- a/libnetwork/resolvconf/resolvconf.go +++ b/libnetwork/resolvconf/resolvconf.go @@ -149,12 +149,11 @@ func GetLastModified() *File { } // FilterResolvDNS cleans up the config in resolvConf. It has two main jobs: -// 1. It looks for localhost (127.*|::1) entries in the provided -// resolv.conf, removing local nameserver entries, and, if the resulting -// cleaned config has no defined nameservers left, adds default DNS entries -// 2. Given the caller provides the enable/disable state of IPv6, the filter -// code will remove all IPv6 nameservers if it is not enabled for containers -// +// 1. It looks for localhost (127.*|::1) entries in the provided +// resolv.conf, removing local nameserver entries, and, if the resulting +// cleaned config has no defined nameservers left, adds default DNS entries +// 2. Given the caller provides the enable/disable state of IPv6, the filter +// code will remove all IPv6 nameservers if it is not enabled for containers func FilterResolvDNS(resolvConf []byte, ipv6Enabled bool) (*File, error) { cleanedResolvConf := localhostNSRegexp.ReplaceAll(resolvConf, []byte{}) // if IPv6 is not enabled, also clean out any IPv6 address nameserver diff --git a/libnetwork/testutils/context_unix.go b/libnetwork/testutils/context_unix.go index 601c00f91d..23e1fb6f6b 100644 --- a/libnetwork/testutils/context_unix.go +++ b/libnetwork/testutils/context_unix.go @@ -16,8 +16,7 @@ import ( // // Example usage: // -// defer SetupTestOSContext(t)() -// +// defer SetupTestOSContext(t)() func SetupTestOSContext(t *testing.T) func() { runtime.LockOSThread() if err := syscall.Unshare(syscall.CLONE_NEWNET); err != nil { diff --git a/libnetwork/testutils/context_windows.go b/libnetwork/testutils/context_windows.go index a770596f3e..4fa3372962 100644 --- a/libnetwork/testutils/context_windows.go +++ b/libnetwork/testutils/context_windows.go @@ -7,8 +7,7 @@ import "testing" // // Example usage: // -// defer SetupTestOSContext(t)() -// +// defer SetupTestOSContext(t)() func SetupTestOSContext(t *testing.T) func() { return func() {} } diff --git a/oci/oci.go b/oci/oci.go index c64077da76..2021ec3538 100644 --- a/oci/oci.go +++ b/oci/oci.go @@ -8,13 +8,14 @@ import ( specs "github.com/opencontainers/runtime-spec/specs-go" ) -// TODO verify if this regex is correct for "a" (all); the docs (https://github.com/torvalds/linux/blob/v5.10/Documentation/admin-guide/cgroup-v1/devices.rst) describe: -// "'all' means it applies to all types and all major and minor numbers", and shows an example -// that *only* passes `a` as value: `echo a > /sys/fs/cgroup/1/devices.allow, which would be -// the "implicit" equivalent of "a *:* rwm". Source-code also looks to confirm this, and returns -// early for "a" (all); https://github.com/torvalds/linux/blob/v5.10/security/device_cgroup.c#L614-L642 -//nolint: gosimple -var deviceCgroupRuleRegex = regexp.MustCompile("^([acb]) ([0-9]+|\\*):([0-9]+|\\*) ([rwm]{1,3})$") +// TODO verify if this regex is correct for "a" (all); +// +// The docs (https://github.com/torvalds/linux/blob/v5.10/Documentation/admin-guide/cgroup-v1/devices.rst) describe: +// "'all' means it applies to all types and all major and minor numbers", and shows an example +// that *only* passes `a` as value: `echo a > /sys/fs/cgroup/1/devices.allow, which would be +// the "implicit" equivalent of "a *:* rwm". Source-code also looks to confirm this, and returns +// early for "a" (all); https://github.com/torvalds/linux/blob/v5.10/security/device_cgroup.c#L614-L642 +var deviceCgroupRuleRegex = regexp.MustCompile("^([acb]) ([0-9]+|\\*):([0-9]+|\\*) ([rwm]{1,3})$") //nolint: gosimple // SetCapabilities sets the provided capabilities on the spec // All capabilities are added if privileged is true. diff --git a/pkg/archive/archive.go b/pkg/archive/archive.go index 50f5ae2979..fe87093054 100644 --- a/pkg/archive/archive.go +++ b/pkg/archive/archive.go @@ -730,7 +730,7 @@ func createTarFile(path, extractDir string, hdr *tar.Header, reader io.Reader, L } case tar.TypeLink: - //#nosec G305 -- The target path is checked for path traversal. + // #nosec G305 -- The target path is checked for path traversal. targetPath := filepath.Join(extractDir, hdr.Linkname) // check for hardlink breakout if !strings.HasPrefix(targetPath, extractDir) { @@ -743,7 +743,7 @@ func createTarFile(path, extractDir string, hdr *tar.Header, reader io.Reader, L case tar.TypeSymlink: // path -> hdr.Linkname = targetPath // e.g. /extractDir/path/to/symlink -> ../2/file = /extractDir/path/2/file - targetPath := filepath.Join(filepath.Dir(path), hdr.Linkname) //#nosec G305 -- The target path is checked for path traversal. + targetPath := filepath.Join(filepath.Dir(path), hdr.Linkname) // #nosec G305 -- The target path is checked for path traversal. // the reason we don't need to check symlinks in the path (with FollowSymlinkInScope) is because // that symlink would first have to be created, which would be caught earlier, at this very check: @@ -1099,7 +1099,7 @@ loop: } } - //#nosec G305 -- The joined path is checked for path traversal. + // #nosec G305 -- The joined path is checked for path traversal. path := filepath.Join(dest, hdr.Name) rel, err := filepath.Rel(dest, path) if err != nil { @@ -1164,7 +1164,7 @@ loop: } for _, hdr := range dirs { - //#nosec G305 -- The header was checked for path traversal before it was appended to the dirs slice. + // #nosec G305 -- The header was checked for path traversal before it was appended to the dirs slice. path := filepath.Join(dest, hdr.Name) if err := system.Chtimes(path, hdr.AccessTime, hdr.ModTime); err != nil { @@ -1177,7 +1177,8 @@ loop: // Untar reads a stream of bytes from `archive`, parses it as a tar archive, // and unpacks it into the directory at `dest`. // The archive may be compressed with one of the following algorithms: -// identity (uncompressed), gzip, bzip2, xz. +// identity (uncompressed), gzip, bzip2, xz. +// // FIXME: specify behavior when target path exists vs. doesn't exist. func Untar(tarArchive io.Reader, dest string, options *TarOptions) error { return untarHandler(tarArchive, dest, options, true) diff --git a/pkg/archive/archive_linux_test.go b/pkg/archive/archive_linux_test.go index 51a9a0f6d4..bfc84ad91b 100644 --- a/pkg/archive/archive_linux_test.go +++ b/pkg/archive/archive_linux_test.go @@ -15,13 +15,14 @@ import ( // setupOverlayTestDir creates files in a directory with overlay whiteouts // Tree layout -// . -// ├── d1 # opaque, 0700 -// │ └── f1 # empty file, 0600 -// ├── d2 # opaque, 0750 -// │ └── f1 # empty file, 0660 -// └── d3 # 0700 -// └── f1 # whiteout, 0644 +// +// . +// ├── d1 # opaque, 0700 +// │ └── f1 # empty file, 0600 +// ├── d2 # opaque, 0750 +// │ └── f1 # empty file, 0660 +// └── d3 # 0700 +// └── f1 # whiteout, 0644 func setupOverlayTestDir(t *testing.T, src string) { skip.If(t, os.Getuid() != 0, "skipping test that requires root") skip.If(t, userns.RunningInUserNS(), "skipping test that requires initial userns (trusted.overlay.opaque xattr cannot be set in userns, even with Ubuntu kernel)") diff --git a/pkg/archive/copy_unix_test.go b/pkg/archive/copy_unix_test.go index efb20e225d..2f421fe78e 100644 --- a/pkg/archive/copy_unix_test.go +++ b/pkg/archive/copy_unix_test.go @@ -297,9 +297,10 @@ func TestCopyLongDstFilename(t *testing.T) { // J | yes | yes | yes | yes | - | copy dir contents // -// A. SRC specifies a file and DST (no trailing path separator) doesn't -// exist. This should create a file with the name DST and copy the -// contents of the source file into it. +// A. SRC specifies a file and DST (no trailing path separator) doesn't exist. +// +// This should create a file with the name DST and copy the contents of the source +// file into it. func TestCopyCaseA(t *testing.T) { tmpDirA, tmpDirB := getTestTempDirs(t) defer removeAllPaths(tmpDirA, tmpDirB) @@ -339,9 +340,10 @@ func TestCopyCaseA(t *testing.T) { assert.NilError(t, err) } -// B. SRC specifies a file and DST (with trailing path separator) doesn't -// exist. This should cause an error because the copy operation cannot -// create a directory when copying a single file. +// B. SRC specifies a file and DST (with trailing path separator) doesn't exist. +// +// This should cause an error because the copy operation cannot create a directory +// when copying a single file. func TestCopyCaseB(t *testing.T) { tmpDirA, tmpDirB := getTestTempDirs(t) defer removeAllPaths(tmpDirA, tmpDirB) @@ -373,8 +375,9 @@ func TestCopyCaseB(t *testing.T) { } -// C. SRC specifies a file and DST exists as a file. This should overwrite -// the file at DST with the contents of the source file. +// C. SRC specifies a file and DST exists as a file. +// +// This should overwrite the file at DST with the contents of the source file. func TestCopyCaseC(t *testing.T) { tmpDirA, tmpDirB := getTestTempDirs(t) defer removeAllPaths(tmpDirA, tmpDirB) @@ -401,9 +404,9 @@ func TestCopyCaseC(t *testing.T) { assert.NilError(t, err) } -// C. Symbol link following version: -// SRC specifies a file and DST exists as a file. This should overwrite -// the file at DST with the contents of the source file. +// C. Symbol link following version: SRC specifies a file and DST exists as a file. +// +// This should overwrite the file at DST with the contents of the source file. func TestCopyCaseCFSym(t *testing.T) { tmpDirA, tmpDirB := getTestTempDirs(t) defer removeAllPaths(tmpDirA, tmpDirB) @@ -438,9 +441,10 @@ func TestCopyCaseCFSym(t *testing.T) { assert.NilError(t, err) } -// D. SRC specifies a file and DST exists as a directory. This should place -// a copy of the source file inside it using the basename from SRC. Ensure -// this works whether DST has a trailing path separator or not. +// D. SRC specifies a file and DST exists as a directory. +// +// This should place a copy of the source file inside it using the basename from +// SRC. Ensure this works whether DST has a trailing path separator or not. func TestCopyCaseD(t *testing.T) { tmpDirA, tmpDirB := getTestTempDirs(t) defer removeAllPaths(tmpDirA, tmpDirB) @@ -487,10 +491,10 @@ func TestCopyCaseD(t *testing.T) { assert.NilError(t, err) } -// D. Symbol link following version: -// SRC specifies a file and DST exists as a directory. This should place -// a copy of the source file inside it using the basename from SRC. Ensure -// this works whether DST has a trailing path separator or not. +// D. Symbol link following version: SRC specifies a file and DST exists as a directory. +// +// This should place a copy of the source file inside it using the basename from +// SRC. Ensure this works whether DST has a trailing path separator or not. func TestCopyCaseDFSym(t *testing.T) { tmpDirA, tmpDirB := getTestTempDirs(t) defer removeAllPaths(tmpDirA, tmpDirB) @@ -538,10 +542,11 @@ func TestCopyCaseDFSym(t *testing.T) { assert.NilError(t, err) } -// E. SRC specifies a directory and DST does not exist. This should create a -// directory at DST and copy the contents of the SRC directory into the DST -// directory. Ensure this works whether DST has a trailing path separator or -// not. +// E. SRC specifies a directory and DST does not exist. +// +// This should create a directory at DST and copy the contents of the SRC directory +// into the DST directory. Ensure this works whether DST has a trailing path +// separator or not. func TestCopyCaseE(t *testing.T) { tmpDirA, tmpDirB := getTestTempDirs(t) defer removeAllPaths(tmpDirA, tmpDirB) @@ -581,11 +586,11 @@ func TestCopyCaseE(t *testing.T) { assert.NilError(t, err) } -// E. Symbol link following version: -// SRC specifies a directory and DST does not exist. This should create a -// directory at DST and copy the contents of the SRC directory into the DST -// directory. Ensure this works whether DST has a trailing path separator or -// not. +// E. Symbol link following version: SRC specifies a directory and DST does not exist. +// +// This should create a directory at DST and copy the contents of the SRC directory +// into the DST directory. Ensure this works whether DST has a trailing path +// separator or not. func TestCopyCaseEFSym(t *testing.T) { tmpDirA, tmpDirB := getTestTempDirs(t) defer removeAllPaths(tmpDirA, tmpDirB) @@ -626,8 +631,10 @@ func TestCopyCaseEFSym(t *testing.T) { assert.NilError(t, err) } -// F. SRC specifies a directory and DST exists as a file. This should cause an -// error as it is not possible to overwrite a file with a directory. +// F. SRC specifies a directory and DST exists as a file. +// +// This should cause an error as it is not possible to overwrite a file with a +// directory. func TestCopyCaseF(t *testing.T) { tmpDirA, tmpDirB := getTestTempDirs(t) defer removeAllPaths(tmpDirA, tmpDirB) @@ -660,9 +667,10 @@ func TestCopyCaseF(t *testing.T) { } } -// G. SRC specifies a directory and DST exists as a directory. This should copy -// the SRC directory and all its contents to the DST directory. Ensure this -// works whether DST has a trailing path separator or not. +// G. SRC specifies a directory and DST exists as a directory. +// +// This should copy the SRC directory and all its contents to the DST directory. +// Ensure this works whether DST has a trailing path separator or not. func TestCopyCaseG(t *testing.T) { tmpDirA, tmpDirB := getTestTempDirs(t) defer removeAllPaths(tmpDirA, tmpDirB) @@ -704,10 +712,10 @@ func TestCopyCaseG(t *testing.T) { assert.NilError(t, err) } -// G. Symbol link version: -// SRC specifies a directory and DST exists as a directory. This should copy -// the SRC directory and all its contents to the DST directory. Ensure this -// works whether DST has a trailing path separator or not. +// G. Symbol link version: SRC specifies a directory and DST exists as a directory. +// +// This should copy the SRC directory and all its contents to the DST directory. +// Ensure this works whether DST has a trailing path separator or not. func TestCopyCaseGFSym(t *testing.T) { tmpDirA, tmpDirB := getTestTempDirs(t) defer removeAllPaths(tmpDirA, tmpDirB) @@ -750,10 +758,11 @@ func TestCopyCaseGFSym(t *testing.T) { assert.NilError(t, err) } -// H. SRC specifies a directory's contents only and DST does not exist. This -// should create a directory at DST and copy the contents of the SRC -// directory (but not the directory itself) into the DST directory. Ensure -// this works whether DST has a trailing path separator or not. +// H. SRC specifies a directory's contents only and DST does not exist. +// +// This should create a directory at DST and copy the contents of the SRC +// directory (but not the directory itself) into the DST directory. Ensure +// this works whether DST has a trailing path separator or not. func TestCopyCaseH(t *testing.T) { tmpDirA, tmpDirB := getTestTempDirs(t) defer removeAllPaths(tmpDirA, tmpDirB) @@ -797,11 +806,11 @@ func TestCopyCaseH(t *testing.T) { } } -// H. Symbol link following version: -// SRC specifies a directory's contents only and DST does not exist. This -// should create a directory at DST and copy the contents of the SRC -// directory (but not the directory itself) into the DST directory. Ensure -// this works whether DST has a trailing path separator or not. +// H. Symbol link following version: SRC specifies a directory's contents only and DST does not exist. +// +// This should create a directory at DST and copy the contents of the SRC +// directory (but not the directory itself) into the DST directory. Ensure +// this works whether DST has a trailing path separator or not. func TestCopyCaseHFSym(t *testing.T) { tmpDirA, tmpDirB := getTestTempDirs(t) defer removeAllPaths(tmpDirA, tmpDirB) @@ -846,9 +855,10 @@ func TestCopyCaseHFSym(t *testing.T) { } } -// I. SRC specifies a directory's contents only and DST exists as a file. This -// should cause an error as it is not possible to overwrite a file with a -// directory. +// I. SRC specifies a directory's contents only and DST exists as a file. +// +// This should cause an error as it is not possible to overwrite a file with a +// directory. func TestCopyCaseI(t *testing.T) { tmpDirA, tmpDirB := getTestTempDirs(t) defer removeAllPaths(tmpDirA, tmpDirB) @@ -882,9 +892,10 @@ func TestCopyCaseI(t *testing.T) { } // J. SRC specifies a directory's contents only and DST exists as a directory. -// This should copy the contents of the SRC directory (but not the directory -// itself) into the DST directory. Ensure this works whether DST has a -// trailing path separator or not. +// +// This should copy the contents of the SRC directory (but not the directory +// itself) into the DST directory. Ensure this works whether DST has a +// trailing path separator or not. func TestCopyCaseJ(t *testing.T) { tmpDirA, tmpDirB := getTestTempDirs(t) defer removeAllPaths(tmpDirA, tmpDirB) @@ -930,11 +941,11 @@ func TestCopyCaseJ(t *testing.T) { assert.NilError(t, err) } -// J. Symbol link following version: -// SRC specifies a directory's contents only and DST exists as a directory. -// This should copy the contents of the SRC directory (but not the directory -// itself) into the DST directory. Ensure this works whether DST has a -// trailing path separator or not. +// J. Symbol link following version: SRC specifies a directory's contents only and DST exists as a directory. +// +// This should copy the contents of the SRC directory (but not the directory +// itself) into the DST directory. Ensure this works whether DST has a +// trailing path separator or not. func TestCopyCaseJFSym(t *testing.T) { tmpDirA, tmpDirB := getTestTempDirs(t) defer removeAllPaths(tmpDirA, tmpDirB) diff --git a/pkg/archive/wrap.go b/pkg/archive/wrap.go index 85435694cf..032db82cea 100644 --- a/pkg/archive/wrap.go +++ b/pkg/archive/wrap.go @@ -17,8 +17,8 @@ import ( // Generate("foo.txt", "hello world", "emptyfile") // // The above call will return an archive with 2 files: -// * ./foo.txt with content "hello world" -// * ./empty with empty content +// - ./foo.txt with content "hello world" +// - ./empty with empty content // // FIXME: stream content instead of buffering // FIXME: specify permissions and other archive metadata diff --git a/pkg/chrootarchive/archive.go b/pkg/chrootarchive/archive.go index 656355f978..0620157df9 100644 --- a/pkg/chrootarchive/archive.go +++ b/pkg/chrootarchive/archive.go @@ -30,7 +30,7 @@ func NewArchiver(idMapping idtools.IdentityMapping) *archive.Archiver { // Untar reads a stream of bytes from `archive`, parses it as a tar archive, // and unpacks it into the directory at `dest`. // The archive may be compressed with one of the following algorithms: -// identity (uncompressed), gzip, bzip2, xz. +// identity (uncompressed), gzip, bzip2, xz. func Untar(tarArchive io.Reader, dest string, options *archive.TarOptions) error { return untarHandler(tarArchive, dest, options, true, dest) } diff --git a/pkg/devicemapper/devmapper.go b/pkg/devicemapper/devmapper.go index 05456c67ee..688b7f9932 100644 --- a/pkg/devicemapper/devmapper.go +++ b/pkg/devicemapper/devmapper.go @@ -15,7 +15,7 @@ import ( ) // Same as DM_DEVICE_* enum values from libdevmapper.h -//nolint: deadcode,unused,varcheck +// nolint: deadcode,unused,varcheck const ( deviceCreate TaskType = iota deviceReload diff --git a/pkg/devicemapper/devmapper_log.go b/pkg/devicemapper/devmapper_log.go index aa47368258..ed7343a278 100644 --- a/pkg/devicemapper/devmapper_log.go +++ b/pkg/devicemapper/devmapper_log.go @@ -39,6 +39,7 @@ func LogInit(logger DevmapperLogger) { // because we are using callbacks, this function will be called for *every* log // in libdm (even debug ones because there's no way of setting the verbosity // level for an external logging callback). +// //export DevmapperLogCallback func DevmapperLogCallback(level C.int, file *C.char, line, dmErrnoOrClass C.int, message *C.char) { msg := C.GoString(message) diff --git a/pkg/parsers/parsers.go b/pkg/parsers/parsers.go index 068e524807..e6d7b33ec0 100644 --- a/pkg/parsers/parsers.go +++ b/pkg/parsers/parsers.go @@ -25,13 +25,14 @@ func ParseKeyValueOpt(opt string) (string, string, error) { // set to `true`. Values larger than `maximum` cause an error if max is non zero, // in order to stop the map becoming excessively large. // Supported formats: -// 7 -// 1-6 -// 0,3-4,7,8-10 -// 0-0,0,1-7 -// 03,1-3 <- this is gonna get parsed as [1,2,3] -// 3,2,1 -// 0-2,3,1 +// +// 7 +// 1-6 +// 0,3-4,7,8-10 +// 0-0,0,1-7 +// 03,1-3 <- this is gonna get parsed as [1,2,3] +// 3,2,1 +// 0-2,3,1 func ParseUintListMaximum(val string, maximum int) (map[int]bool, error) { return parseUintList(val, maximum) } @@ -42,13 +43,14 @@ func ParseUintListMaximum(val string, maximum int) (map[int]bool, error) { // input string. It returns a `map[int]bool` with available elements from `val` // set to `true`. // Supported formats: -// 7 -// 1-6 -// 0,3-4,7,8-10 -// 0-0,0,1-7 -// 03,1-3 <- this is gonna get parsed as [1,2,3] -// 3,2,1 -// 0-2,3,1 +// +// 7 +// 1-6 +// 0,3-4,7,8-10 +// 0-0,0,1-7 +// 03,1-3 <- this is gonna get parsed as [1,2,3] +// 3,2,1 +// 0-2,3,1 func ParseUintList(val string) (map[int]bool, error) { return parseUintList(val, 0) } diff --git a/pkg/plugins/plugins.go b/pkg/plugins/plugins.go index 86023046fa..c352d10663 100644 --- a/pkg/plugins/plugins.go +++ b/pkg/plugins/plugins.go @@ -13,7 +13,7 @@ // A handshake is send at /Plugin.Activate, and plugins are expected to return // a Manifest with a list of Docker subsystems which this plugin implements. // -// In order to use a plugins, you can use the ``Get`` with the name of the +// In order to use a plugins, you can use the `Get` with the name of the // plugin and the subsystem it implements. // // plugin, err := plugins.Get("example", "VolumeDriver") diff --git a/pkg/system/meminfo_windows.go b/pkg/system/meminfo_windows.go index 6ed93f2fe2..124d2c502d 100644 --- a/pkg/system/meminfo_windows.go +++ b/pkg/system/meminfo_windows.go @@ -27,7 +27,7 @@ type memorystatusex struct { } // ReadMemInfo retrieves memory statistics of the host system and returns a -// MemInfo type. +// MemInfo type. func ReadMemInfo() (*MemInfo, error) { msi := &memorystatusex{ dwLength: 64, diff --git a/plugin/store.go b/plugin/store.go index 114fcf17a1..76d9acbfd6 100644 --- a/plugin/store.go +++ b/plugin/store.go @@ -14,16 +14,14 @@ import ( "github.com/sirupsen/logrus" ) -/* allowV1PluginsFallback determines daemon's support for V1 plugins. - * When the time comes to remove support for V1 plugins, flipping - * this bool is all that will be needed. - */ +// allowV1PluginsFallback determines daemon's support for V1 plugins. +// When the time comes to remove support for V1 plugins, flipping +// this bool is all that will be needed. const allowV1PluginsFallback = true -/* defaultAPIVersion is the version of the plugin API for volume, network, - IPAM and authz. This is a very stable API. When we update this API, then - pluginType should include a version. e.g. "networkdriver/2.0". -*/ +// defaultAPIVersion is the version of the plugin API for volume, network, +// IPAM and authz. This is a very stable API. When we update this API, then +// pluginType should include a version. e.g. "networkdriver/2.0". const defaultAPIVersion = "1.0" // GetV2Plugin retrieves a plugin by name, id or partial ID. diff --git a/quota/projectquota.go b/quota/projectquota.go index 13d2efefe5..28217831ff 100644 --- a/quota/projectquota.go +++ b/quota/projectquota.go @@ -102,9 +102,10 @@ func (state *pquotaState) updateMinProjID(minProjectID uint32) { // This test will fail if the backing fs is not xfs. // // xfs_quota tool can be used to assign a project id to the driver home directory, e.g.: -// echo 999:/var/lib/docker/overlay2 >> /etc/projects -// echo docker:999 >> /etc/projid -// xfs_quota -x -c 'project -s docker' /<xfs mount point> +// +// echo 999:/var/lib/docker/overlay2 >> /etc/projects +// echo docker:999 >> /etc/projid +// xfs_quota -x -c 'project -s docker' /<xfs mount point> // // In that case, the home directory project id will be used as a "start offset" // and all containers will be assigned larger project ids (e.g. >= 1000). @@ -113,7 +114,6 @@ func (state *pquotaState) updateMinProjID(minProjectID uint32) { // Then try to create a test directory with the next project id and set a quota // on it. If that works, continue to scan existing containers to map allocated // project ids. -// func NewControl(basePath string) (*Control, error) { // // If we are running in a user namespace quota won't be supported for diff --git a/volume/drivers/extpoint.go b/volume/drivers/extpoint.go index 3878736cbb..970c909f72 100644 --- a/volume/drivers/extpoint.go +++ b/volume/drivers/extpoint.go @@ -21,13 +21,13 @@ const extName = "VolumeDriver" // volumeDriver defines the available functions that volume plugins must implement. // This interface is only defined to generate the proxy objects. // It's not intended to be public or reused. -//nolint: deadcode +// nolint: deadcode,unused,varcheck type volumeDriver interface { // Create a volume with the given name Create(name string, opts map[string]string) (err error) // Remove the volume with the given name Remove(name string) (err error) - // Get the mountpoint of the given volume + // Path returns the mountpoint of the given volume. Path(name string) (mountpoint string, err error) // Mount the given volume and return the mountpoint Mount(name, id string) (mountpoint string, err error) diff --git a/volume/mounts/lcow_parser.go b/volume/mounts/lcow_parser.go index 2dbd2d164b..3158f39024 100644 --- a/volume/mounts/lcow_parser.go +++ b/volume/mounts/lcow_parser.go @@ -22,9 +22,9 @@ func NewLCOWParser() Parser { // rxLCOWDestination is the regex expression for the mount destination for LCOW // // Destination (aka container path): -// - Variation on hostdir but can be a drive followed by colon as well -// - If a path, must be absolute. Can include spaces -// - Drive cannot be c: (explicitly checked in code, not RegEx) +// - Variation on hostdir but can be a drive followed by colon as well +// - If a path, must be absolute. Can include spaces +// - Drive cannot be c: (explicitly checked in code, not RegEx) const rxLCOWDestination = `(?P<destination>/(?:[^\\/:*?"<>\r\n]+[/]?)*)` var ( diff --git a/volume/service/store.go b/volume/service/store.go index dd3805524b..8926866e1c 100644 --- a/volume/service/store.go +++ b/volume/service/store.go @@ -571,7 +571,7 @@ func volumeExists(ctx context.Context, store *drivers.Store, v volume.Volume) (b // create asks the given driver to create a volume with the name/opts. // If a volume with the name is already known, it will ask the stored driver for the volume. // If the passed in driver name does not match the driver name which is stored -// for the given volume name, an error is returned after checking if the reference is stale. +// for the given volume name, an error is returned after checking if the reference is stale. // If the reference is stale, it will be purged and this create can continue. // It is expected that callers of this function hold any necessary locks. func (s *VolumeStore) create(ctx context.Context, name, driverName string, opts, labels map[string]string) (volume.Volume, bool, error) { @@ -749,9 +749,9 @@ func (s *VolumeStore) getVolume(ctx context.Context, name, driverName string) (v // lookupVolume gets the specified volume from the specified driver. // This will only return errors related to communications with the driver. -// If the driver returns an error that is not communication related the -// error is logged but not returned. -// If the volume is not found it will return `nil, nil`` +// If the driver returns an error that is not communication related, the error +// is logged but not returned. +// If the volume is not found it will return `nil, nil` // TODO(@cpuguy83): plumb through the context to lower level components func lookupVolume(ctx context.Context, store *drivers.Store, driverName, volumeName string) (volume.Volume, error) { if driverName == "" { |