Explorar o código

Merge pull request #31207 from duglin/BuildArgDocs

Add even more docs around BuildArgs and *string
Vincent Demeester %!s(int64=8) %!d(string=hai) anos
pai
achega
aef8aa565f
Modificáronse 1 ficheiros con 4 adicións e 3 borrados
  1. 4 3
      api/types/client.go

+ 4 - 3
api/types/client.go

@@ -160,9 +160,10 @@ type ImageBuildOptions struct {
 	ShmSize        int64
 	Dockerfile     string
 	Ulimits        []*units.Ulimit
-	// See the parsing of buildArgs in api/server/router/build/build_routes.go
-	// for an explanation of why BuildArgs needs to use *string instead of
-	// just a string
+	// BuildArgs needs to be a *string instead of just a string so that
+	// we can tell the difference between "" (empty string) and no value
+	// at all (nil). See the parsing of buildArgs in
+	// api/server/router/build/build_routes.go for even more info.
 	BuildArgs   map[string]*string
 	AuthConfigs map[string]AuthConfig
 	Context     io.Reader