From 17ce34116af4e8c6b66d0c7906efcae2fd75efc6 Mon Sep 17 00:00:00 2001 From: Hu Keping Date: Wed, 22 Jul 2015 05:20:12 +0800 Subject: [PATCH] golint: use golint to check package util Signed-off-by: Hu Keping --- utils/experimental.go | 2 ++ utils/git.go | 2 ++ utils/stubs.go | 2 ++ utils/utils.go | 8 ++++---- 4 files changed, 10 insertions(+), 4 deletions(-) diff --git a/utils/experimental.go b/utils/experimental.go index b308a59faf..ceed0cb3ff 100644 --- a/utils/experimental.go +++ b/utils/experimental.go @@ -2,6 +2,8 @@ package utils +// ExperimentalBuild is a stub which always returns true for +// builds that include the "experimental" build tag func ExperimentalBuild() bool { return true } diff --git a/utils/git.go b/utils/git.go index 6c039bddbe..4d0bb16417 100644 --- a/utils/git.go +++ b/utils/git.go @@ -14,6 +14,8 @@ import ( "github.com/docker/docker/pkg/urlutil" ) +// GitClone clones a repository into a newly created directory which +// will be under "docker-build-git" func GitClone(remoteURL string) (string, error) { if !urlutil.IsGitTransport(remoteURL) { remoteURL = "https://" + remoteURL diff --git a/utils/stubs.go b/utils/stubs.go index b376f0cfb5..8a496d392f 100644 --- a/utils/stubs.go +++ b/utils/stubs.go @@ -2,6 +2,8 @@ package utils +// ExperimentalBuild is a stub which always returns false for +// builds that do not include the "experimental" build tag func ExperimentalBuild() bool { return false } diff --git a/utils/utils.go b/utils/utils.go index cb1b7b34cc..57418fda1e 100644 --- a/utils/utils.go +++ b/utils/utils.go @@ -19,7 +19,7 @@ import ( "github.com/docker/docker/pkg/stringid" ) -// Figure out the absolute path of our own binary (if it's still around). +// SelfPath figures out the absolute path of our own binary (if it's still around). func SelfPath() string { path, err := exec.LookPath(os.Args[0]) if err != nil { @@ -79,7 +79,7 @@ func isValidDockerInitPath(target string, selfPath string) bool { // target and return dockerversion.INITSHA1 != "" && dockerInitSha1(target) == dockerversion.INITSHA1 } -// Figure out the path of our dockerinit (which may be SelfPath()) +// DockerInitPath figures out the path of our dockerinit (which may be SelfPath()) func DockerInitPath(localCopy string) string { selfPath := SelfPath() if isValidDockerInitPath(selfPath, selfPath) { @@ -157,7 +157,7 @@ func GetCallerName(depth int) string { return callerShortName } -// ReplaceOrAppendValues returns the defaults with the overrides either +// ReplaceOrAppendEnvValues returns the defaults with the overrides either // replaced by env key or appended to the list func ReplaceOrAppendEnvValues(defaults, overrides []string) []string { cache := make(map[string]int, len(defaults)) @@ -239,7 +239,7 @@ func ValidateContextDirectory(srcPath string, excludes []string) error { }) } -// Reads a .dockerignore file and returns the list of file patterns +// ReadDockerIgnore reads a .dockerignore file and returns the list of file patterns // to ignore. Note this will trim whitespace from each line as well // as use GO's "clean" func to get the shortest/cleanest path for each. func ReadDockerIgnore(path string) ([]string, error) {