Browse Source

Add comments to api/common constants, closes #11583

Signed-off-by: Avi Das <andas222@gmail.com>
Avi Das 10 years ago
parent
commit
c136591f40
1 changed files with 5 additions and 4 deletions
  1. 5 4
      api/common.go

+ 5 - 4
api/common.go

@@ -14,11 +14,12 @@ import (
 	"github.com/docker/libtrust"
 	"github.com/docker/libtrust"
 )
 )
 
 
+// Common constants for daemon and client.
 const (
 const (
-	APIVERSION            version.Version = "1.18"
-	DEFAULTHTTPHOST                       = "127.0.0.1"
-	DEFAULTUNIXSOCKET                     = "/var/run/docker.sock"
-	DefaultDockerfileName string          = "Dockerfile"
+	APIVERSION            version.Version = "1.18"                 // Current REST API version
+	DEFAULTHTTPHOST                       = "127.0.0.1"            // Default HTTP Host used if only port is provided to -H flag e.g. docker -d -H tcp://:8080
+	DEFAULTUNIXSOCKET                     = "/var/run/docker.sock" // Docker daemon by default always listens on the default unix socket
+	DefaultDockerfileName string          = "Dockerfile"           // Default filename with Docker commands, read by docker build
 )
 )
 
 
 func ValidateHost(val string) (string, error) {
 func ValidateHost(val string) (string, error) {