chore: add docs reminder comments for driver opts

Signed-off-by: David Karlsson <[email protected]>
docker · Nov 16, 2023 · 1326634 · 1326634
1 parent 7a724ac
commit 1326634
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 2 deletions.
diff --git a/driver/docker-container/driver.go b/driver/docker-container/driver.go
@@ -40,7 +40,10 @@ const (
 
 type Driver struct {
 	driver.InitConfig
-	factory      driver.Factory
+	factory driver.Factory
+
+	// if you add fields, remember to update docs:
+	// https://github.com/docker/docs/blob/main/content/build/drivers/docker-container.md
 	netMode      string
 	image        string
 	memory       opts.MemBytes

diff --git a/driver/docker/driver.go b/driver/docker/driver.go
@@ -17,6 +17,8 @@ type Driver struct {
 	factory driver.Factory
 	driver.InitConfig
 
+	// if you add fields, remember to update docs:
+	// https://github.com/docker/docs/blob/main/content/build/drivers/docker.md
 	features    features
 	hostGateway hostGateway
 }

diff --git a/driver/kubernetes/driver.go b/driver/kubernetes/driver.go
@@ -38,7 +38,10 @@ const (
 
 type Driver struct {
 	driver.InitConfig
-	factory          driver.Factory
+	factory driver.Factory
+
+	// if you add fields, remember to update docs:
+	// https://github.com/docker/docs/blob/main/content/build/drivers/kubernetes.md
 	minReplicas      int
 	deployment       *appsv1.Deployment
 	configMaps       []*corev1.ConfigMap

diff --git a/driver/remote/driver.go b/driver/remote/driver.go
@@ -14,6 +14,9 @@ import (
 type Driver struct {
 	factory driver.Factory
 	driver.InitConfig
+
+	// if you add fields, remember to update docs:
+	// https://github.com/docker/docs/blob/main/content/build/drivers/remote.md
 	*tlsOpts
 }