浏览代码

/image - fix lint errors/warnings
Addresses #14756
Signed-off-by: Srini Brahmaroutu <srbrahma@us.ibm.com>

root 10 年之前
父节点
当前提交
b061572916
共有 2 个文件被更改,包括 28 次插入14 次删除
  1. 1 0
      hack/make/validate-lint
  2. 27 14
      image/image.go

+ 1 - 0
hack/make/validate-lint

@@ -17,6 +17,7 @@ packages=(
 	daemon/network
 	docker
 	dockerinit
+	image
 	integration-cli
 	pkg/chrootarchive
 	pkg/directory

+ 27 - 14
image/image.go

@@ -11,22 +11,35 @@ import (
 
 var validHex = regexp.MustCompile(`^([a-f0-9]{64})$`)
 
+// Image stores the image configuration.
 type Image struct {
-	ID              string            `json:"id"`
-	Parent          string            `json:"parent,omitempty"`
-	Comment         string            `json:"comment,omitempty"`
-	Created         time.Time         `json:"created"`
-	Container       string            `json:"container,omitempty"`
-	ContainerConfig runconfig.Config  `json:"container_config,omitempty"`
-	DockerVersion   string            `json:"docker_version,omitempty"`
-	Author          string            `json:"author,omitempty"`
-	Config          *runconfig.Config `json:"config,omitempty"`
-	Architecture    string            `json:"architecture,omitempty"`
-	OS              string            `json:"os,omitempty"`
-	Size            int64
+	// ID a unique 64 character identifier of the image
+	ID string `json:"id"`
+	// Parent id of the image
+	Parent string `json:"parent,omitempty"`
+	// Comment user added comment
+	Comment string `json:"comment,omitempty"`
+	// Created timestamp when image was created
+	Created time.Time `json:"created"`
+	// Container is the id of the container used to commit
+	Container string `json:"container,omitempty"`
+	// ContainerConfig  is the configuration of the container that is committed into the image
+	ContainerConfig runconfig.Config `json:"container_config,omitempty"`
+	// DockerVersion specifies version on which image is built
+	DockerVersion string `json:"docker_version,omitempty"`
+	// Author of the image
+	Author string `json:"author,omitempty"`
+	// Config is the configuration of the container received from the client
+	Config *runconfig.Config `json:"config,omitempty"`
+	// Architecture is the hardware that the image is build and runs on
+	Architecture string `json:"architecture,omitempty"`
+	// OS is the operating system used to build and run the image
+	OS string `json:"os,omitempty"`
+	// Size is the total size of the image including all layers it is composed of
+	Size int64
 }
 
-// Build an Image object from raw json data
+// NewImgJSON creates an Image configuration from json.
 func NewImgJSON(src []byte) (*Image, error) {
 	ret := &Image{}
 
@@ -37,7 +50,7 @@ func NewImgJSON(src []byte) (*Image, error) {
 	return ret, nil
 }
 
-// Check wheather id is a valid image ID or not
+// ValidateID checks whether an ID string is a valid image ID.
 func ValidateID(id string) error {
 	if ok := validHex.MatchString(id); !ok {
 		return fmt.Errorf("image ID '%s' is invalid", id)