Forráskód Böngészése

Add even more docs around BuildArgs and *string

PR #31197 made me think I needed to add more text explaing why
BuildArgs needs to be a *string instead of string.

Signed-off-by: Doug Davis <dug@us.ibm.com>
Doug Davis 8 éve
szülő
commit
9419ccd706
1 módosított fájl, 4 hozzáadás és 3 törlés
  1. 4 3
      api/types/client.go

+ 4 - 3
api/types/client.go

@@ -160,9 +160,10 @@ type ImageBuildOptions struct {
 	ShmSize        int64
 	ShmSize        int64
 	Dockerfile     string
 	Dockerfile     string
 	Ulimits        []*units.Ulimit
 	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
 	BuildArgs   map[string]*string
 	AuthConfigs map[string]AuthConfig
 	AuthConfigs map[string]AuthConfig
 	Context     io.Reader
 	Context     io.Reader