From 275d8ab8defc6ca3e9a8785db285b427f4393d28 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Sun, 16 Apr 2017 12:51:29 -0500 Subject: [PATCH] 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 --- docs/reference/commandline/history.md | 23 ++++++++--------- man/src/image/history.md | 36 +++++++++++++++++++++++++++ 2 files changed, 46 insertions(+), 13 deletions(-) diff --git a/docs/reference/commandline/history.md b/docs/reference/commandline/history.md index cfc52f83b7..014ceddaf3 100644 --- a/docs/reference/commandline/history.md +++ b/docs/reference/commandline/history.md @@ -58,19 +58,19 @@ c69cab00d6ef 5 months ago /bin/sh -c #(nop) MAINTAINER Lokesh Mand ### Format the output -The formatting option (`--format`) will pretty print history output +The formatting option (`--format`) will pretty-prints history output using a Go template. Valid placeholders for the Go template are listed below: -| Placeholder | Description| -| ---- | ---- | -| `.ID` | Image ID | -| `.CreatedSince` | Elapsed time since the image was created if --human=true, otherwise timestamp of when image was created | -| `.CreatedAt` | Timestamp of when image was created | -| `.CreatedBy` | Command that was used to create the image | -| `.Size` | Image disk size | -| `.Comment` | Comment for image | +| Placeholder | Description | +| --------------- | ----------- | +| `.ID` | Image ID | +| `.CreatedSince` | Elapsed time since the image was created if `--human=true`, otherwise timestamp of when image was created | +| `.CreatedAt` | Timestamp of when image was created | +| `.CreatedBy` | Command that was used to create the image | +| `.Size` | Image disk size | +| `.Comment` | Comment for image | When using the `--format` option, the `history` command will either 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 `ID` and `CreatedSince` entries separated by a colon for all images: ```bash -{% raw %} $ docker images --format "{{.ID}}: {{.Created}} ago" cc1b61406712: 2 weeks ago @@ -91,6 +90,4 @@ cc1b61406712: 2 weeks ago : 3 weeks ago : 3 weeks ago : 3 weeks ago - -{% endraw %} -``` \ No newline at end of file +``` diff --git a/man/src/image/history.md b/man/src/image/history.md index da7e5d64a5..cef058e50e 100644 --- a/man/src/image/history.md +++ b/man/src/image/history.md @@ -16,3 +16,39 @@ The `docker commit` command has a **-m** flag for adding comments to the image. 88b42ffd1f7c 5 months ago /bin/sh -c #(nop) ADD file:1fd8d7f9f6557cafc7 373.7 MB c69cab00d6ef 5 months ago /bin/sh -c #(nop) MAINTAINER Lokesh Mandvekar 0 B 511136ea3c5a 19 months ago 0 B Imported from - + +### Format the output + +The formatting option (`--format`) will pretty-prints history output +using a Go template. + +Valid placeholders for the Go template are listed below: + +| Placeholder | Description | +| --------------- | ----------- | +| `.ID` | Image ID | +| `.CreatedSince` | Elapsed time since the image was created if `--human=true`, otherwise timestamp of when image was created | +| `.CreatedAt` | Timestamp of when image was created | +| `.CreatedBy` | Command that was used to create the image | +| `.Size` | Image disk size | +| `.Comment` | Comment for image | + +When using the `--format` option, the `history` command will either +output the data exactly as the template declares or, when using the +`table` directive, will include column headers as well. + +The following example uses a template without headers and outputs the +`ID` and `CreatedSince` entries separated by a colon for all images: + +```bash +$ docker images --format "{{.ID}}: {{.Created}} ago" + +cc1b61406712: 2 weeks ago +: 2 weeks ago +: 2 weeks ago +: 2 weeks ago +: 2 weeks ago +: 3 weeks ago +: 3 weeks ago +: 3 weeks ago +```