Browse code

updated documentation for mentioning images vs containers

Docker-DCO-1.1-Signed-off-by: Robin Speekenbrink <robin@kingsquare.nl> (github: fruitl00p)

rebased by

Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit)

Robin Speekenbrink authored on 2014/05/08 22:11:17
Showing 14 changed files
... ...
@@ -47,7 +47,7 @@ func (cli *DockerCli) CmdHelp(args ...string) error {
47 47
 	help := fmt.Sprintf("Usage: docker [OPTIONS] COMMAND [arg...]\n -H=[unix://%s]: tcp://host:port to bind/connect to or unix://path/to/socket to use\n\nA self-sufficient runtime for linux containers.\n\nCommands:\n", api.DEFAULTUNIXSOCKET)
48 48
 	for _, command := range [][]string{
49 49
 		{"attach", "Attach to a running container"},
50
-		{"build", "Build a container from a Dockerfile"},
50
+		{"build", "Build an image from a Dockerfile"},
51 51
 		{"commit", "Create a new image from a container's changes"},
52 52
 		{"cp", "Copy files/folders from the containers filesystem to the host path"},
53 53
 		{"diff", "Inspect changes on a container's filesystem"},
... ...
@@ -105,7 +105,7 @@ func (cli *DockerCli) CmdInsert(args ...string) error {
105 105
 }
106 106
 
107 107
 func (cli *DockerCli) CmdBuild(args ...string) error {
108
-	cmd := cli.Subcmd("build", "[OPTIONS] PATH | URL | -", "Build a new container image from the source code at PATH")
108
+	cmd := cli.Subcmd("build", "[OPTIONS] PATH | URL | -", "Build a new image from the source code at PATH")
109 109
 	tag := cmd.String([]string{"t", "-tag"}, "", "Repository name (and optionally a tag) to be applied to the resulting image in case of success")
110 110
 	suppressOutput := cmd.Bool([]string{"q", "-quiet"}, false, "Suppress the verbose output generated by the containers")
111 111
 	noCache := cmd.Bool([]string{"#no-cache", "-no-cache"}, false, "Do not use cache when building the image")
... ...
@@ -71,7 +71,7 @@ complete -c docker -A -f -n '__fish_seen_subcommand_from attach' -l sig-proxy -d
71 71
 complete -c docker -A -f -n '__fish_seen_subcommand_from attach' -a '(__fish_print_docker_containers running)' -d "Container"
72 72
 
73 73
 # build
74
-complete -c docker -f -n '__fish_docker_no_subcommand' -a build -d 'Build a container from a Dockerfile'
74
+complete -c docker -f -n '__fish_docker_no_subcommand' -a build -d 'Build an image from a Dockerfile'
75 75
 complete -c docker -A -f -n '__fish_seen_subcommand_from build' -l no-cache -d 'Do not use cache when building the image'
76 76
 complete -c docker -A -f -n '__fish_seen_subcommand_from build' -s q -l quiet -d 'Suppress the verbose output generated by the containers'
77 77
 complete -c docker -A -f -n '__fish_seen_subcommand_from build' -l rm -d 'Remove intermediate containers after a successful build'
... ...
@@ -2,7 +2,7 @@
2 2
 % William Henry
3 3
 % APRIL 2014
4 4
 # NAME
5
-docker-build - Build a container image from a Dockerfile source at PATH
5
+docker-build - Build an image from a Dockerfile source at PATH
6 6
 
7 7
 # SYNOPSIS
8 8
 **docker build** [**--no-cache**[=*false*]] [**-q**|**--quiet**[=*false*]]
... ...
@@ -81,7 +81,7 @@ port=[4243] or path =[/var/run/docker.sock] is omitted, default values are used.
81 81
   Attach to a running container
82 82
 
83 83
 **docker-build(1)**
84
-  Build a container from a Dockerfile
84
+  Build an image from a Dockerfile
85 85
 
86 86
 **docker-commit(1)**
87 87
   Create a new image from a container's changes
... ...
@@ -3,7 +3,7 @@
3 3
 .\"
4 4
 .TH "DOCKER" "1" "MARCH 2014" "0.1" "Docker"
5 5
 .SH NAME
6
-docker-build \- Build a container image from a Dockerfile source at PATH
6
+docker-build \- Build an image from a Dockerfile source at PATH
7 7
 .SH SYNOPSIS
8 8
 .B docker build 
9 9
 [\fB--no-cache\fR[=\fIfalse\fR] 
... ...
@@ -69,7 +69,7 @@ Print version information and quit
69 69
 Attach to a running container
70 70
 .TP
71 71
 .B build 
72
-Build a container from a Dockerfile
72
+Build an image from a Dockerfile
73 73
 .TP
74 74
 .B commit 
75 75
 Create a new image from a container's changes
... ...
@@ -58,7 +58,7 @@ There are three steps:
58 58
    containerized CFEngine installation.
59 59
 3. Start your application processes as part of the `docker run` command.
60 60
 
61
-### Building the container image
61
+### Building the image
62 62
 
63 63
 The first two steps can be done as part of a Dockerfile, as follows.
64 64
 
... ...
@@ -87,7 +87,7 @@ The first two steps can be done as part of a Dockerfile, as follows.
87 87
     ENTRYPOINT ["/var/cfengine/bin/docker_processes_run.sh"]
88 88
 
89 89
 By saving this file as Dockerfile to a working directory, you can then build
90
-your container with the docker build command, e.g.
90
+your image with the docker build command, e.g.
91 91
 `docker build -t managed_image`.
92 92
 
93 93
 ### Testing the container
... ...
@@ -95,9 +95,9 @@ Here We've exposed ports 22 and 80 on the container and we're running
95 95
 the `/usr/bin/supervisord` binary when the container
96 96
 launches.
97 97
 
98
-## Building our container
98
+## Building our image
99 99
 
100
-We can now build our new container.
100
+We can now build our new image.
101 101
 
102 102
     $ sudo docker build -t <yourname>/supervisord .
103 103
 
... ...
@@ -83,7 +83,7 @@ You will see a list of all currently available commands.
83 83
 
84 84
     Commands:
85 85
          attach    Attach to a running container
86
-         build     Build a container from a Dockerfile
86
+         build     Build an image from a Dockerfile
87 87
          commit    Create a new image from a container's changes
88 88
     . . .
89 89
 
... ...
@@ -2,7 +2,7 @@ This directory holds the authoritative specifications of APIs defined and implem
2 2
 
3 3
  * The remote API by which a docker node can be queried over HTTP
4 4
  * The registry API by which a docker node can download and upload
5
-   container images for storage and sharing
5
+   images for storage and sharing
6 6
  * The index search API by which a docker node can search the public
7 7
    index for images to download
8 8
  * The docker.io OAuth and accounts API which 3rd party services can
... ...
@@ -190,7 +190,7 @@ To kill the container, use `docker kill`.
190 190
 
191 191
     Usage: docker build [OPTIONS] PATH | URL | -
192 192
 
193
-    Build a new container image from the source code at PATH
193
+    Build a new image from the source code at PATH
194 194
 
195 195
       --force-rm=false     Always remove intermediate containers, even after unsuccessful builds
196 196
       --no-cache=false     Do not use cache when building the image
... ...
@@ -157,7 +157,7 @@ TCP and a Unix socket
157 157
 
158 158
 ## Committing (saving) a container state
159 159
 
160
-Save your containers state to a container image, so the state can be
160
+Save your containers state to an image, so the state can be
161 161
 re-used.
162 162
 
163 163
 When you commit your container only the differences between the image
... ...
@@ -171,7 +171,7 @@ will be stored (as a diff). See which images you already have using the
171 171
     # List your containers
172 172
     $ sudo docker images
173 173
 
174
-You now have a image state from which you can create new instances.
174
+You now have an image state from which you can create new instances.
175 175
 
176 176
 Read more about [*Share Images via Repositories*](
177 177
 ../workingwithrepository/#working-with-the-repository) or
... ...
@@ -70,7 +70,7 @@ EXAMPLES:
70 70
 
71 71
 #### Builder
72 72
 
73
-+ 'docker build -t FOO .' applies the tag FOO to the newly built container
73
++ 'docker build -t FOO .' applies the tag FOO to the newly built image
74 74
 
75 75
 #### Remote API
76 76
 
... ...
@@ -18,7 +18,7 @@ set -e
18 18
 # - The right way to call this script is to invoke "make" from
19 19
 #   your checkout of the Docker repository.
20 20
 #   the Makefile will do a "docker build -t docker ." and then
21
-#   "docker run hack/make.sh" in the resulting container image.
21
+#   "docker run hack/make.sh" in the resulting image.
22 22
 #
23 23
 
24 24
 set -o pipefail