From 2271096e46dfbfb521bf73cc409a20fb870d7652 Mon Sep 17 00:00:00 2001
From: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Date: Thu, 16 Nov 2023 16:03:48 +0100
Subject: [PATCH] chore: add docs reminder comments for driver opts

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
(cherry picked from commit 1326634c7d116c036b855af139c1f7af8bdfa6b4)
---
 driver/docker-container/driver.go | 5 ++++-
 driver/docker/driver.go           | 2 ++
 driver/kubernetes/driver.go       | 5 ++++-
 driver/remote/driver.go           | 3 +++
 4 files changed, 13 insertions(+), 2 deletions(-)

diff --git a/driver/docker-container/driver.go b/driver/docker-container/driver.go
index b79e2f00..b0df7e8d 100644
--- a/driver/docker-container/driver.go
+++ b/driver/docker-container/driver.go
@@ -39,7 +39,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
index 0bed4187..0138b11b 100644
--- 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
index d46448be..d78872c3 100644
--- 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
index 2efd2263..4f85b40a 100644
--- 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
 }