DockerCLI/man
Ian Campbell 0808cf04cb Add `docker build --iidfile=FILE`
This is synonymous with `docker run --cidfile=FILE` and writes the digest of
the newly built image to the named file. This is intended to be used by build
systems which want to avoid tagging (perhaps because they are in CI or
otherwise want to avoid fixed names which can clash) by enabling e.g. Makefile
constructs like:

    image.id: Dockerfile
    	docker build --iidfile=image.id .

    do-some-more-stuff: image.id
    	do-stuff-with <image.id

Currently the only way to achieve this is to use `docker build -q` and capture
the stdout, but at the expense of losing the build output.

In non-silent mode (without `-q`) with API >= v1.29 the caller will now see a
`JSONMessage` with the `Aux` field containing a `types.BuildResult` in the
output stream for each image/layer produced during the build, with the final
one being the end product.  Having all of the intermediate images might be
interesting in some cases.

In silent mode (with `-q`) there is no change, on success the only output will
be the resulting image digest as it was previosuly.

There was no wrapper to just output an Aux section without enclosing it in a
Progress, so add one here.

Added some tests to integration cli tests.

Signed-off-by: Ian Campbell <ian.campbell@docker.com>
2017-06-02 00:11:04 +00:00
..
src Minor fixups for history CLI reference 2017-06-02 00:11:03 +00:00
Dockerfile from golang:1.7.5-alpine for docker-manpage-dev 2017-06-02 00:10:52 +00:00
Dockerfile.5.md Convert Unused ARG error to warning 2017-06-02 00:10:31 +00:00
Dockerfile.aarch64 Incorporated feedback from review 2017-06-02 00:10:57 +00:00
Dockerfile.armhf remove musl-dev in man/Dockerfile.armhf 2017-06-02 00:10:53 +00:00
Dockerfile.ppc64le added ppc64le and s390x fixes for manpages 2017-06-02 00:10:53 +00:00
Dockerfile.s390x added ppc64le and s390x fixes for manpages 2017-06-02 00:10:53 +00:00
README.md Make README less scabious 2017-06-02 00:10:02 +00:00
docker-build.1.md Add `docker build --iidfile=FILE` 2017-06-02 00:11:04 +00:00
docker-config-json.5.md man: mv config-json.5 to docker-config-json.5 2017-06-02 00:07:42 +00:00
docker-run.1.md remove --init-path from client 2017-06-02 00:11:03 +00:00
docker.1.md Update the manuals of docker and dockerd 2017-06-02 00:10:46 +00:00
dockerd.8.md Add option to auto-configure blkdev for devmapper 2017-06-02 00:11:04 +00:00
generate.go Add example for device-cgroup-rule to man 2017-06-02 00:10:51 +00:00
generate.sh Convert script shebangs from "#!/bin/bash" to "#!/usr/bin/env bash" 2017-06-02 00:10:54 +00:00
glide.lock Update sfp13/pflag 2017-06-02 00:10:25 +00:00
glide.yaml Add a script to generate man pages from cobra commands. 2017-06-02 00:07:51 +00:00
md2man-all.sh Convert script shebangs from "#!/bin/bash" to "#!/usr/bin/env bash" 2017-06-02 00:10:54 +00:00

README.md

Docker Documentation

This directory contains scripts for generating the man pages. Many of the man pages are generated directly from the spf13/cobra Command definition. Some legacy pages are still generated from the markdown files in this directory. Do not edit the man pages in the man1 directory. Instead, update the Cobra command or amend the Markdown files for legacy pages.

Generate the man pages

From within the project root directory run:

make manpages