Browse code

Add comments to api/common constants, closes #11583

Signed-off-by: Avi Das <andas222@gmail.com>

Avi Das authored on 2015/03/24 10:30:09
Showing 1 changed files
... ...
@@ -14,11 +14,12 @@ import (
14 14
 	"github.com/docker/libtrust"
15 15
 )
16 16
 
17
+// Common constants for daemon and client.
17 18
 const (
18
-	APIVERSION            version.Version = "1.18"
19
-	DEFAULTHTTPHOST                       = "127.0.0.1"
20
-	DEFAULTUNIXSOCKET                     = "/var/run/docker.sock"
21
-	DefaultDockerfileName string          = "Dockerfile"
19
+	APIVERSION            version.Version = "1.18"                 // Current REST API version
20
+	DEFAULTHTTPHOST                       = "127.0.0.1"            // Default HTTP Host used if only port is provided to -H flag e.g. docker -d -H tcp://:8080
21
+	DEFAULTUNIXSOCKET                     = "/var/run/docker.sock" // Docker daemon by default always listens on the default unix socket
22
+	DefaultDockerfileName string          = "Dockerfile"           // Default filename with Docker commands, read by docker build
22 23
 )
23 24
 
24 25
 func ValidateHost(val string) (string, error) {