Bug 1381929
| Summary: | docker-images and docker-inspect man pages lacks simple --format example | ||
|---|---|---|---|
| Product: | Red Hat Enterprise Linux 7 | Reporter: | Marek Haicman <mhaicman> |
| Component: | docker | Assignee: | Antonio Murdaca <amurdaca> |
| Status: | CLOSED ERRATA | QA Contact: | atomic-bugs <atomic-bugs> |
| Severity: | unspecified | Docs Contact: | |
| Priority: | unspecified | ||
| Version: | 7.3 | CC: | ajia, amurdaca, dwalsh, lsm5, lsu |
| Target Milestone: | rc | Keywords: | Extras |
| Target Release: | --- | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | |||
| Fixed In Version: | docker-1.12.6-1.el7_3 | Doc Type: | If docs needed, set a value |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | 2017-03-02 19:09:22 UTC | Type: | Bug |
| Regression: | --- | Mount Type: | --- |
| Documentation: | --- | CRM: | |
| Verified Versions: | Category: | --- | |
| oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | |
| Cloudforms Team: | --- | Target Upstream Version: | |
| Embargoed: | |||
sudo docker images --format "{{.ID}}: {{.Tag}}\t{{.Repository}}"
Is a good example. I will try to add it.
Added an example to docker/man/docker-images.1.md PR: https://github.com/docker/docker/pull/28734 At github docker/docker: added this to the 1.13.0 milestone merged commit 60e72ea into docker:master Marek, I've fixed the 'docker images --format' example upstream. Have you looked at that? Is it enough? https://github.com/docker/docker/pull/28734 As you pointed out the inspect has examples already and also the inspect structure is more complex so the examples try to show how to find some of the deeper level elements. Is it intuitive enough or is a simpler example still required? Dan, any thoughts? William Looks good to me. Fixed in docker-1.13 or docker-latest-1.13. I think these examples are perfect, thanks! Backported to docker-1.12.5 branch, Lokesh could you rebuild for RHEL so QE can re-test this out again? will be shipped in 7.3.3 Via docker-1.12.6-5.el7.x86_64, move to verified Since the problem described in this bug report should be resolved in a recent advisory, it has been closed with a resolution of ERRATA. For information on the advisory, and where to find the updated files, follow the link below. If the solution does not work for you, open a new bug report. https://rhn.redhat.com/errata/RHBA-2017-0406.html |
Description of problem: As a user of Docker, I was stuck how to form --format field, for `docker images' command. There is no example, only a mention of "go template". As my use case was to create very simple formatting [reduce field to one], all I needed was example like the one in `man docker ps', nothing complex. docker ps --format "{{.ID}}: {{.Command}}" In the case of "man docker-inspect", there is one example, but is quite complex. Version-Release number of selected component (if applicable): docker-1.10.3-53.el7.x86_64 How reproducible: always Steps to Reproduce: 1. man docker images Actual results: Go template is mentioned, but no example provided Expected results: At least some very simple example is there, so admin without experience with Go language can do simple formatting immediately. Additional info: Other man pages lack simple example of formatting, but it's probably not necessary to update them, as these are advanced commands: man docker-network-inspect (golang.org reference is explicit) man docker-volume-inspect (golang.org reference is explicit)