Browse code

blindly make all uses of e\.?g\.? into e.g.,

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

SvenDowideit authored on 2014/06/30 10:31:15
Showing 32 changed files
... ...
@@ -70,7 +70,7 @@ in their shell:
70 70
 
71 71
 ### Images
72 72
 
73
-When you need to add images, try to make them as small as possible (e.g. as
73
+When you need to add images, try to make them as small as possible (e.g., as
74 74
 gifs). Usually images should go in the same directory as the `.md` file which
75 75
 references them, or in a subdirectory if one already exists.
76 76
 
... ...
@@ -14,7 +14,7 @@ Using an existing container's name or ID you can create a new image.
14 14
 
15 15
 # OPTIONS
16 16
 **-a, --author**=""
17
-   Author name. (e.g. "John Hannibal Smith <hannibal@a-team.com>"
17
+   Author name. (e.g., "John Hannibal Smith <hannibal@a-team.com>"
18 18
 
19 19
 **-m, --message**=""
20 20
    Commit message
... ...
@@ -17,7 +17,7 @@ docker-images - List the images in the local repository
17 17
 This command lists the images stored in the local Docker repository.
18 18
 
19 19
 By default, intermediate images, used during builds, are not listed. Some of the
20
-output, e.g. image ID, is truncated, for space reasons. However the truncated
20
+output, e.g., image ID, is truncated, for space reasons. However the truncated
21 21
 image ID, and often the first few characters, are enough to be used in other
22 22
 Docker commands that use the image ID. The output includes repository, tag, image
23 23
 ID, date created and the virtual size.
... ...
@@ -142,7 +142,7 @@ output:
142 142
 
143 143
 ## Getting information on an image
144 144
 
145
-Use an image's ID or name (e.g. repository/name[:tag]) to get information
145
+Use an image's ID or name (e.g., repository/name[:tag]) to get information
146 146
  on it.
147 147
 
148 148
     # docker inspect 58394af37342
... ...
@@ -10,7 +10,7 @@ docker-pull - Pull an image or a repository from the registry
10 10
 # DESCRIPTION
11 11
 
12 12
 This command pulls down an image or a repository from the registry. If
13
-there is more than one image for a repository (e.g. fedora) then all
13
+there is more than one image for a repository (e.g., fedora) then all
14 14
 images for that repository name are pulled down including any tags.
15 15
 It is also possible to specify a non-default registry to pull from.
16 16
 
... ...
@@ -71,7 +71,7 @@ stopping the process by pressing the keys CTRL-P CTRL-Q.
71 71
 **--dns**=*IP-address*
72 72
    Set custom DNS servers. This option can be used to override the DNS
73 73
 configuration passed to the container. Typically this is necessary when the
74
-host DNS configuration is invalid for the container (e.g. 127.0.0.1). When this
74
+host DNS configuration is invalid for the container (e.g., 127.0.0.1). When this
75 75
 is the case the **-dns** flags is necessary for every run.
76 76
 
77 77
 
... ...
@@ -35,7 +35,7 @@ Note that here TAG is a part of the overall name or "tag".
35 35
 
36 36
 ## Giving an image a new alias
37 37
 
38
-Here is an example of aliasing an image (e.g. 0e5574283393) as "httpd" and 
38
+Here is an example of aliasing an image (e.g., 0e5574283393) as "httpd" and 
39 39
 tagging it into the "fedora" repository with "version1.0":
40 40
 
41 41
     docker tag 0e5574283393 fedora/httpd:version1.0
... ...
@@ -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 image 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
... ...
@@ -29,7 +29,7 @@ keys:
29 29
     $ openssl req -new -x509 -days 365 -key ca-key.pem -out ca.pem
30 30
 
31 31
 Now that we have a CA, you can create a server key and certificate
32
-signing request. Make sure that "Common Name (e.g. server FQDN or YOUR
32
+signing request. Make sure that "Common Name (e.g., server FQDN or YOUR
33 33
 name)" matches the hostname you will use to connect to Docker or just
34 34
 use `\*` for a certificate valid for any hostname:
35 35
 
... ...
@@ -35,7 +35,7 @@ known to the system, the hierarchy they belong to, and how many groups they cont
35 35
 
36 36
 You can also look at `/proc/<pid>/cgroup` to see which control groups a process
37 37
 belongs to. The control group will be shown as a path relative to the root of
38
-the hierarchy mountpoint; e.g. `/` means “this process has not been assigned into
38
+the hierarchy mountpoint; e.g., `/` means “this process has not been assigned into
39 39
 a particular group”, while `/lxc/pumpkin` means that the process is likely to be
40 40
 a member of a container named `pumpkin`.
41 41
 
... ...
@@ -106,9 +106,9 @@ to the processes within the cgroup, excluding sub-cgroups. The second half
106 106
 (with the `total_` prefix) includes sub-cgroups as well.
107 107
 
108 108
 Some metrics are "gauges", i.e. values that can increase or decrease
109
-(e.g. swap, the amount of swap space used by the members of the cgroup).
109
+(e.g., swap, the amount of swap space used by the members of the cgroup).
110 110
 Some others are "counters", i.e. values that can only go up, because
111
-they represent occurrences of a specific event (e.g. pgfault, which
111
+they represent occurrences of a specific event (e.g., pgfault, which
112 112
 indicates the number of page faults which happened since the creation of
113 113
 the cgroup; this number can never decrease).
114 114
 
... ...
@@ -410,7 +410,7 @@ used.
410 410
 
411 411
 Docker makes this difficult because it relies on `lxc-start`, which
412 412
 carefully cleans up after itself, but it is still possible. It is
413
-usually easier to collect metrics at regular intervals (e.g. every
413
+usually easier to collect metrics at regular intervals (e.g., every
414 414
 minute, with the collectd LXC plugin) and rely on that instead.
415 415
 
416 416
 But, if you'd still like to gather the stats when a container stops,
... ...
@@ -91,8 +91,8 @@ without any restriction. This sounds crazy? Well, you have to know that
91 91
 same way**. Nothing prevents you from sharing your root filesystem (or
92 92
 even your root block device) with a virtual machine.
93 93
 
94
-This has a strong security implication: if you instrument Docker from
95
-e.g. a web server to provision containers through an API, you should be
94
+This has a strong security implication: for example, if you instrument Docker
95
+from a web server to provision containers through an API, you should be
96 96
 even more careful than usual with parameter checking, to make sure that
97 97
 a malicious user cannot pass crafted parameters causing Docker to create
98 98
 arbitrary containers.
... ...
@@ -108,7 +108,7 @@ socket.
108 108
 You can also expose the REST API over HTTP if you explicitly decide so.
109 109
 However, if you do that, being aware of the above mentioned security
110 110
 implication, you should ensure that it will be reachable only from a
111
-trusted network or VPN; or protected with e.g. `stunnel` and client SSL
111
+trusted network or VPN; or protected with e.g., `stunnel` and client SSL
112 112
 certificates. You can also secure them with [HTTPS and
113 113
 certificates](/articles/https/).
114 114
 
... ...
@@ -136,7 +136,7 @@ Finally, if you run Docker on a server, it is recommended to run
136 136
 exclusively Docker in the server, and move all other services within
137 137
 containers controlled by Docker. Of course, it is fine to keep your
138 138
 favorite admin tools (probably at least an SSH server), as well as
139
-existing monitoring/supervision processes (e.g. NRPE, collectd, etc).
139
+existing monitoring/supervision processes (e.g., NRPE, collectd, etc).
140 140
 
141 141
 ## Linux Kernel Capabilities
142 142
 
... ...
@@ -154,8 +154,8 @@ This means a lot for container security; let's see why!
154 154
 
155 155
 Your average server (bare metal or virtual machine) needs to run a bunch
156 156
 of processes as root. Those typically include SSH, cron, syslogd;
157
-hardware management tools (to e.g. load modules), network configuration
158
-tools (to handle e.g. DHCP, WPA, or VPNs), and much more. A container is
157
+hardware management tools (e.g., load modules), network configuration
158
+tools (e.g., to handle DHCP, WPA, or VPNs), and much more. A container is
159 159
 very different, because almost all of those tasks are handled by the
160 160
 infrastructure around the container:
161 161
 
... ...
@@ -232,7 +232,7 @@ harden a Docker host. Here are a few examples.
232 232
    mechanism.
233 233
 
234 234
 Just like there are many third-party tools to augment Docker containers
235
-with e.g. special network topologies or shared filesystems, you can
235
+with e.g., special network topologies or shared filesystems, you can
236 236
 expect to see tools to harden existing Docker containers without
237 237
 affecting Docker's core.
238 238
 
... ...
@@ -113,7 +113,7 @@ something like this
113 113
     ok      github.com/dotcloud/docker/utils        0.017s
114 114
 
115 115
 If $TESTFLAGS is set in the environment, it is passed as extra arguments
116
-to `go test`. You can use this to select certain tests to run, e.g.
116
+to `go test`. You can use this to select certain tests to run, e.g.,
117 117
 
118 118
     $ TESTFLAGS=`-run \^TestBuild\$` make test
119 119
 
... ...
@@ -15,7 +15,7 @@ will need to install it. And this is a little more difficult on
15 15
 Rackspace.
16 16
 
17 17
 Rackspace boots their servers using grub's `menu.lst`
18
-and does not like non `virtual` packages (e.g. Xen compatible)
18
+and does not like non `virtual` packages (e.g., Xen compatible)
19 19
 kernels there, although they do work. This results in
20 20
 `update-grub` not having the expected result, and
21 21
 you will need to set the kernel manually.
... ...
@@ -373,7 +373,7 @@ List containers (/containers/json):
373 373
 
374 374
 Start containers (/containers/<id>/start):
375 375
 
376
- - You can now pass host-specific configuration (e.g. bind mounts) in
376
+ - You can now pass host-specific configuration (e.g., bind mounts) in
377 377
    the POST body for start calls
378 378
 
379 379
 ## v1.2
... ...
@@ -935,7 +935,7 @@ Create a new image from a container's changes
935 935
     -   **repo** – repository
936 936
     -   **tag** – tag
937 937
     -   **m** – commit message
938
-    -   **author** – author (e.g. "John Hannibal Smith
938
+    -   **author** – author (e.g., "John Hannibal Smith
939 939
         <[hannibal@a-team.com](mailto:hannibal%40a-team.com)>")
940 940
 
941 941
     Status Codes:
... ...
@@ -946,7 +946,7 @@ Create a new image from a container's changes
946 946
     -   **repo** – repository
947 947
     -   **tag** – tag
948 948
     -   **m** – commit message
949
-    -   **author** – author (e.g. "John Hannibal Smith
949
+    -   **author** – author (e.g., "John Hannibal Smith
950 950
         <[hannibal@a-team.com](mailto:hannibal%40a-team.com)>")
951 951
 
952 952
     Status Codes:
... ...
@@ -286,7 +286,7 @@ List processes running inside the container `id`
286 286
 
287 287
      
288 288
 
289
-    -   **ps\_args** – ps arguments to use (e.g. aux)
289
+    -   **ps\_args** – ps arguments to use (e.g., aux)
290 290
 
291 291
     Status Codes:
292 292
 
... ...
@@ -1181,7 +1181,7 @@ Create a new image from a container's changes
1181 1181
     -   **repo** – repository
1182 1182
     -   **tag** – tag
1183 1183
     -   **m** – commit message
1184
-    -   **author** – author (e.g. "John Hannibal Smith
1184
+    -   **author** – author (e.g., "John Hannibal Smith
1185 1185
         <[hannibal@a-team.com](mailto:hannibal%40a-team.com)>")
1186 1186
 
1187 1187
     Status Codes:
... ...
@@ -290,7 +290,7 @@ List processes running inside the container `id`
290 290
 
291 291
      
292 292
 
293
-    -   **ps_args** – ps arguments to use (e.g. aux)
293
+    -   **ps_args** – ps arguments to use (e.g., aux)
294 294
 
295 295
     Status Codes:
296 296
 
... ...
@@ -1223,7 +1223,7 @@ Create a new image from a container's changes
1223 1223
     -   **repo** – repository
1224 1224
     -   **tag** – tag
1225 1225
     -   **m** – commit message
1226
-    -   **author** – author (e.g. "John Hannibal Smith
1226
+    -   **author** – author (e.g., "John Hannibal Smith
1227 1227
         <[hannibal@a-team.com](mailto:hannibal%40a-team.com)>")
1228 1228
 
1229 1229
     Status Codes:
... ...
@@ -290,7 +290,7 @@ List processes running inside the container `id`
290 290
 
291 291
      
292 292
 
293
-    -   **ps_args** – ps arguments to use (e.g. aux)
293
+    -   **ps_args** – ps arguments to use (e.g., aux)
294 294
 
295 295
     Status Codes:
296 296
 
... ...
@@ -1301,7 +1301,7 @@ Create a new image from a container's changes
1301 1301
     -   **repo** – repository
1302 1302
     -   **tag** – tag
1303 1303
     -   **m** – commit message
1304
-    -   **author** – author (e.g. "John Hannibal Smith
1304
+    -   **author** – author (e.g., "John Hannibal Smith
1305 1305
         <[hannibal@a-team.com](mailto:hannibal%40a-team.com)>")
1306 1306
 
1307 1307
     Status Codes:
... ...
@@ -290,7 +290,7 @@ List processes running inside the container `id`
290 290
 
291 291
      
292 292
 
293
-    -   **ps_args** – ps arguments to use (e.g. aux)
293
+    -   **ps_args** – ps arguments to use (e.g., aux)
294 294
 
295 295
     Status Codes:
296 296
 
... ...
@@ -1304,7 +1304,7 @@ Create a new image from a container's changes
1304 1304
     -   **repo** – repository
1305 1305
     -   **tag** – tag
1306 1306
     -   **m** – commit message
1307
-    -   **author** – author (e.g. "John Hannibal Smith
1307
+    -   **author** – author (e.g., "John Hannibal Smith
1308 1308
         <[hannibal@a-team.com](mailto:hannibal%40a-team.com)>")
1309 1309
 
1310 1310
     Status Codes:
... ...
@@ -959,7 +959,7 @@ Create a new image from a container's changes
959 959
     -   **repo** – repository
960 960
     -   **tag** – tag
961 961
     -   **m** – commit message
962
-    -   **author** – author (e.g. "John Hannibal Smith
962
+    -   **author** – author (e.g., "John Hannibal Smith
963 963
         <[hannibal@a-team.com](mailto:hannibal%40a-team.com)>")
964 964
 
965 965
     Status Codes:
... ...
@@ -1009,7 +1009,7 @@ Create a new image from a container's changes
1009 1009
     -   **repo** – repository
1010 1010
     -   **tag** – tag
1011 1011
     -   **m** – commit message
1012
-    -   **author** – author (e.g. "John Hannibal Smith
1012
+    -   **author** – author (e.g., "John Hannibal Smith
1013 1013
         <[hannibal@a-team.com](mailto:hannibal%40a-team.com)>")
1014 1014
 
1015 1015
     Status Codes:
... ...
@@ -264,7 +264,7 @@ List processes running inside the container `id`
264 264
 
265 265
      
266 266
 
267
-    -   **ps_args** – ps arguments to use (e.g. aux)
267
+    -   **ps_args** – ps arguments to use (e.g., aux)
268 268
 
269 269
     Status Codes:
270 270
 
... ...
@@ -1055,7 +1055,7 @@ Create a new image from a container's changes
1055 1055
     -   **repo** – repository
1056 1056
     -   **tag** – tag
1057 1057
     -   **m** – commit message
1058
-    -   **author** – author (e.g. "John Hannibal Smith
1058
+    -   **author** – author (e.g., "John Hannibal Smith
1059 1059
         <[hannibal@a-team.com](mailto:hannibal%40a-team.com)>")
1060 1060
 
1061 1061
     Status Codes:
... ...
@@ -261,7 +261,7 @@ List processes running inside the container `id`
261 261
 
262 262
      
263 263
 
264
-    -   **ps_args** – ps arguments to use (e.g. aux)
264
+    -   **ps_args** – ps arguments to use (e.g., aux)
265 265
 
266 266
     Status Codes:
267 267
 
... ...
@@ -1067,7 +1067,7 @@ Create a new image from a container's changes
1067 1067
     -   **repo** – repository
1068 1068
     -   **tag** – tag
1069 1069
     -   **m** – commit message
1070
-    -   **author** – author (e.g. "John Hannibal Smith
1070
+    -   **author** – author (e.g., "John Hannibal Smith
1071 1071
         <[hannibal@a-team.com](mailto:hannibal%40a-team.com)>")
1072 1072
 
1073 1073
     Status Codes:
... ...
@@ -311,7 +311,7 @@ List processes running inside the container `id`
311 311
 
312 312
      
313 313
 
314
-    -   **ps_args** – ps arguments to use (e.g. aux)
314
+    -   **ps_args** – ps arguments to use (e.g., aux)
315 315
 
316 316
     Status Codes:
317 317
 
... ...
@@ -1163,7 +1163,7 @@ Create a new image from a container's changes
1163 1163
     -   **repo** – repository
1164 1164
     -   **tag** – tag
1165 1165
     -   **m** – commit message
1166
-    -   **author** – author (e.g. "John Hannibal Smith
1166
+    -   **author** – author (e.g., "John Hannibal Smith
1167 1167
         <[hannibal@a-team.com](mailto:hannibal%40a-team.com)>")
1168 1168
 
1169 1169
     Status Codes:
... ...
@@ -267,7 +267,7 @@ List processes running inside the container `id`
267 267
 
268 268
      
269 269
 
270
-    -   **ps_args** – ps arguments to use (e.g. aux)
270
+    -   **ps_args** – ps arguments to use (e.g., aux)
271 271
 
272 272
     Status Codes:
273 273
 
... ...
@@ -1112,7 +1112,7 @@ Create a new image from a container's changes
1112 1112
     -   **repo** – repository
1113 1113
     -   **tag** – tag
1114 1114
     -   **m** – commit message
1115
-    -   **author** – author (e.g. "John Hannibal Smith
1115
+    -   **author** – author (e.g., "John Hannibal Smith
1116 1116
         <[hannibal@a-team.com](mailto:hannibal%40a-team.com)>")
1117 1117
     -   **run** – config automatically applied when the image is run.
1118 1118
         (ex: {"Cmd": ["cat", "/world"], "PortSpecs":["22"]})
... ...
@@ -303,7 +303,7 @@ List processes running inside the container `id`
303 303
 
304 304
      
305 305
 
306
-    -   **ps_args** – ps arguments to use (e.g. aux)
306
+    -   **ps_args** – ps arguments to use (e.g., aux)
307 307
 
308 308
     Status Codes:
309 309
 
... ...
@@ -1157,7 +1157,7 @@ Create a new image from a container's changes
1157 1157
     -   **repo** – repository
1158 1158
     -   **tag** – tag
1159 1159
     -   **m** – commit message
1160
-    -   **author** – author (e.g. "John Hannibal Smith
1160
+    -   **author** – author (e.g., "John Hannibal Smith
1161 1161
         <[hannibal@a-team.com](mailto:hannibal%40a-team.com)>")
1162 1162
     -   **run** – config automatically applied when the image is run.
1163 1163
         (ex: {"Cmd": ["cat", "/world"], "PortSpecs":["22"]})
... ...
@@ -303,7 +303,7 @@ List processes running inside the container `id`
303 303
 
304 304
      
305 305
 
306
-    -   **ps_args** – ps arguments to use (e.g. aux)
306
+    -   **ps_args** – ps arguments to use (e.g., aux)
307 307
 
308 308
     Status Codes:
309 309
 
... ...
@@ -1194,7 +1194,7 @@ Create a new image from a container's changes
1194 1194
     -   **repo** – repository
1195 1195
     -   **tag** – tag
1196 1196
     -   **m** – commit message
1197
-    -   **author** – author (e.g. "John Hannibal Smith
1197
+    -   **author** – author (e.g., "John Hannibal Smith
1198 1198
         <[hannibal@a-team.com](mailto:hannibal%40a-team.com)>")
1199 1199
 
1200 1200
     Status Codes:
... ...
@@ -77,11 +77,11 @@ grasp the context, here are some examples of registries:
77 77
 > - local mount point;
78 78
 > - remote docker addressed through SSH.
79 79
 
80
-The latter would only require two new commands in docker, e.g.
80
+The latter would only require two new commands in docker, e.g.,
81 81
 `registryget` and `registryput`,
82 82
 wrapping access to the local filesystem (and optionally doing
83 83
 consistency checks). Authentication and authorization are then delegated
84
-to SSH (e.g. with public keys).
84
+to SSH (e.g., with public keys).
85 85
 
86 86
 ### Docker
87 87
 
... ...
@@ -62,10 +62,10 @@ grasp the context, here are some examples of registries:
62 62
 >  - local mount point;
63 63
 >  - remote docker addressed through SSH.
64 64
 
65
-The latter would only require two new commands in docker, e.g.
65
+The latter would only require two new commands in docker, e.g.,
66 66
 `registryget` and `registryput`, wrapping access to the local filesystem
67 67
 (and optionally doing consistency checks). Authentication and authorization
68
-are then delegated to SSH (e.g. with public keys).
68
+are then delegated to SSH (e.g., with public keys).
69 69
 
70 70
 # Endpoints
71 71
 
... ...
@@ -335,7 +335,7 @@ schema.
335 335
 
336 336
     Create a new image from a container's changes
337 337
 
338
-      -a, --author=""     Author (eg. "John Hannibal Smith <hannibal@a-team.com>")
338
+      -a, --author=""     Author (e.g., "John Hannibal Smith <hannibal@a-team.com>")
339 339
       -m, --message=""    Commit message
340 340
 
341 341
 It can be useful to commit a container's file changes or settings into a
... ...
@@ -518,7 +518,7 @@ by default.
518 518
 ### Filtering
519 519
 
520 520
 The filtering flag (`-f` or `--filter`) format is of "key=value". If there are more
521
-than one filter, then pass multiple flags (e.g. `--filter "foo=bar" --filter "bif=baz"`)
521
+than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`)
522 522
 
523 523
 Current filters:
524 524
  * dangling (boolean - true or false)
... ...
@@ -929,7 +929,7 @@ removed before the image is removed.
929 929
       --sig-proxy=true           Proxify received signals to the process (even in non-tty mode). SIGCHLD is not proxied.
930 930
       -t, --tty=false            Allocate a pseudo-tty
931 931
       -u, --user=""              Username or UID
932
-      -v, --volume=[]            Bind mount a volume (e.g. from the host: -v /host:/container, from docker: -v /container)
932
+      -v, --volume=[]            Bind mount a volume (e.g., from the host: -v /host:/container, from docker: -v /container)
933 933
       --volumes-from=[]          Mount volumes from the specified container(s)
934 934
       -w, --workdir=""           Working directory inside the container
935 935
 
... ...
@@ -13,10 +13,10 @@ server.
13 13
 Images can be associated with a repository (or multiple) by giving them
14 14
 an image name using one of three different commands:
15 15
 
16
-1. At build time (e.g. `sudo docker build -t IMAGENAME`),
17
-2. When committing a container (e.g.
16
+1. At build time (e.g., `sudo docker build -t IMAGENAME`),
17
+2. When committing a container (e.g.,
18 18
    `sudo docker commit CONTAINERID IMAGENAME`) or
19
-3. When tagging an image id with an image name (e.g.
19
+3. When tagging an image id with an image name (e.g.,
20 20
    `sudo docker tag IMAGEID IMAGENAME`).
21 21
 
22 22
 A Fully Qualified Image Name (FQIN) can be made up of 3 parts: