1. docker
  2. Commit 2e63c759a264cac09a37ff7f154014038289ca98
Browse code

Minor fixups for history CLI reference

This does some minor fix-ups in the CLI reference
for "history", and copies the formattting section to
the man-pages.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

Sebastiaan van Stijn authored on 2017/04/17 02:51:29
Showing 2 changed files
docs/reference/commandline/history.md
History View file @ 2e63c75
... ... 
@@ -58,19 +58,19 @@ c69cab00d6ef        5 months ago        /bin/sh -c #(nop) MAINTAINER Lokesh Mand
58 58
59 59 
 ### Format the output
60 60
61 
-The formatting option (`--format`) will pretty print history output
61 
+The formatting option (`--format`) will pretty-prints history output
62 62 
 using a Go template.
63 63
64 64 
 Valid placeholders for the Go template are listed below:
65 65
66 
-| Placeholder | Description|
67 
-| ---- | ---- |
68 
-| `.ID` | Image ID |
69 
-| `.CreatedSince` | Elapsed time since the image was created if --human=true, otherwise timestamp of when image was created |
70 
-| `.CreatedAt` | Timestamp of when image was created |
71 
-| `.CreatedBy` | Command that was used to create the image |
72 
-| `.Size` | Image disk size |
73 
-| `.Comment` | Comment for image |
66 
+| Placeholder     | Description |
67 
+| --------------- | ----------- |
68 
+| `.ID`           | Image ID    |
69 
+| `.CreatedSince` | Elapsed time since the image was created if `--human=true`, otherwise timestamp of when image was created |
70 
+| `.CreatedAt`    | Timestamp of when image was created |
71 
+| `.CreatedBy`    | Command that was used to create the image |
72 
+| `.Size`         | Image disk size |
73 
+| `.Comment`      | Comment for image |
74 74
75 75 
 When using the `--format` option, the `history` command will either
76 76 
 output the data exactly as the template declares or, when using the
... ... 
@@ -80,7 +80,6 @@ The following example uses a template without headers and outputs the
80 80 
 `ID` and `CreatedSince` entries separated by a colon for all images:
81 81
82 82 
 ```bash
83 
-{% raw %}
84 83 
 $ docker images --format "{{.ID}}: {{.Created}} ago"
85 84
86 85 
 cc1b61406712: 2 weeks ago
... ... 
@@ -91,6 +90,4 @@ cc1b61406712: 2 weeks ago
91 91 
 <missing>: 3 weeks ago
92 92 
 <missing>: 3 weeks ago
93 93 
 <missing>: 3 weeks ago
94 
-
95 
-{% endraw %}
96 
-```
97 94 
\ No newline at end of file
95 
+```
man/src/image/history.md
History View file @ 2e63c75
... ... 
@@ -16,3 +16,39 @@ The `docker commit` command has a **-m** flag for adding comments to the image.
16 16 
     88b42ffd1f7c        5 months ago        /bin/sh -c #(nop) ADD file:1fd8d7f9f6557cafc7   373.7 MB
17 17 
     c69cab00d6ef        5 months ago        /bin/sh -c #(nop) MAINTAINER Lokesh Mandvekar   0 B
18 18 
     511136ea3c5a        19 months ago                                                       0 B                 Imported from -
19 
+
20 
+### Format the output
21 
+
22 
+The formatting option (`--format`) will pretty-prints history output
23 
+using a Go template.
24 
+
25 
+Valid placeholders for the Go template are listed below:
26 
+
27 
+| Placeholder     | Description |
28 
+| --------------- | ----------- |
29 
+| `.ID`           | Image ID    |
30 
+| `.CreatedSince` | Elapsed time since the image was created if `--human=true`, otherwise timestamp of when image was created |
31 
+| `.CreatedAt`    | Timestamp of when image was created |
32 
+| `.CreatedBy`    | Command that was used to create the image |
33 
+| `.Size`         | Image disk size |
34 
+| `.Comment`      | Comment for image |
35 
+
36 
+When using the `--format` option, the `history` command will either
37 
+output the data exactly as the template declares or, when using the
38 
+`table` directive, will include column headers as well.
39 
+
40 
+The following example uses a template without headers and outputs the
41 
+`ID` and `CreatedSince` entries separated by a colon for all images:
42 
+
43 
+```bash
44 
+$ docker images --format "{{.ID}}: {{.Created}} ago"
45 
+
46 
+cc1b61406712: 2 weeks ago
47 
+<missing>: 2 weeks ago
48 
+<missing>: 2 weeks ago
49 
+<missing>: 2 weeks ago
50 
+<missing>: 2 weeks ago
51 
+<missing>: 3 weeks ago
52 
+<missing>: 3 weeks ago
53 
+<missing>: 3 weeks ago
54 
+```