Browse code

Document the extra `depth` argument in git contexts.

Signed-off-by: David Calavera <david.calavera@gmail.com>

David Calavera authored on 2015/04/24 01:35:19
Showing 1 changed files
... ...
@@ -636,12 +636,13 @@ refer to any of the files in the context. For example, your build can use
636 636
 an [*ADD*](/reference/builder/#add) instruction to reference a file in the
637 637
 context.
638 638
 
639
-The `URL` parameter can specify the location of a Git repository; in this
640
-case,  the repository is the context. The Git repository is recursively
641
-cloned with its submodules.  The system does a fresh `git clone -recursive`
642
-in a temporary directory on your local host. Then, this clone is sent to
643
-the Docker daemon as the context. Local clones give you the ability to
644
-access private repositories using local user credentials, VPN's, and so forth.
639
+The `URL` parameter can specify the location of a Git repository;
640
+the repository acts as the build context.  The system recursively clones the repository
641
+and its submodules using a `git clone --depth 1 --recursive` command.
642
+This command runs in a temporary directory on your local host.
643
+After the command succeeds, the directory is sent to the Docker daemon as the context.
644
+Local clones give you the ability to access private repositories using
645
+local user credentials, VPN's, and so forth.
645 646
 
646 647
 Instead of specifying a context, you can pass a single Dockerfile in the
647 648
 `URL` or pipe the file in via `STDIN`.  To pipe a Dockerfile from `STDIN`: