From e699fc1569446ddbe9d0deb86bb71e77c93bd5ff Mon Sep 17 00:00:00 2001
From: Cian Johnston <cian@coder.com>
Date: Fri, 31 May 2024 16:55:12 +0100
Subject: [PATCH] chore: update docs of ENVBUILDER_GIT_URL to mention
 devcontainer

---
 README.md               | 2 +-
 options.go              | 2 +-
 testdata/options.golden | 3 ++-
 3 files changed, 4 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 7ae3de4b..677fb206 100644
--- a/README.md
+++ b/README.md
@@ -329,7 +329,7 @@ On MacOS or Windows systems, we recommend either using a VM or the provided `.de
 | `--insecure` | `ENVBUILDER_INSECURE` |  | Bypass TLS verification when cloning and pulling from container registries. |
 | `--ignore-paths` | `ENVBUILDER_IGNORE_PATHS` |  | The comma separated list of paths to ignore when building the workspace. |
 | `--skip-rebuild` | `ENVBUILDER_SKIP_REBUILD` |  | Skip building if the MagicFile exists. This is used to skip building when a container is restarting. e.g. docker stop -> docker start This value can always be set to true - even if the container is being started for the first time. |
-| `--git-url` | `ENVBUILDER_GIT_URL` |  | The URL of the Git repository to clone. This is optional. |
+| `--git-url` | `ENVBUILDER_GIT_URL` |  | The URL of a Git repository containing a Devcontainer or Docker image to clone. This is optional. |
 | `--git-clone-depth` | `ENVBUILDER_GIT_CLONE_DEPTH` |  | The depth to use when cloning the Git repository. |
 | `--git-clone-single-branch` | `ENVBUILDER_GIT_CLONE_SINGLE_BRANCH` |  | Clone only a single branch of the Git repository. |
 | `--git-username` | `ENVBUILDER_GIT_USERNAME` |  | The username to use for Git authentication. This is optional. |
diff --git a/options.go b/options.go
index 18c3c990..f0eec636 100644
--- a/options.go
+++ b/options.go
@@ -303,7 +303,7 @@ func (o *Options) CLI() serpent.OptionSet {
 			Flag:        "git-url",
 			Env:         WithEnvPrefix("GIT_URL"),
 			Value:       serpent.StringOf(&o.GitURL),
-			Description: "The URL of the Git repository to clone. This is optional.",
+			Description: "The URL of a Git repository containing a Devcontainer or Docker image to clone. This is optional.",
 		},
 		{
 			Flag:        "git-clone-depth",
diff --git a/testdata/options.golden b/testdata/options.golden
index 38c1ec4f..bab60c21 100644
--- a/testdata/options.golden
+++ b/testdata/options.golden
@@ -94,7 +94,8 @@ OPTIONS:
           Path to an SSH private key to be used for Git authentication.
 
       --git-url string, $ENVBUILDER_GIT_URL
-          The URL of the Git repository to clone. This is optional.
+          The URL of a Git repository containing a Devcontainer or Docker image
+          to clone. This is optional.
 
       --git-username string, $ENVBUILDER_GIT_USERNAME
           The username to use for Git authentication. This is optional.