Files

Yong Tang f08bf3eff7 Make markdown for man pages of docker container ... consistent

This fix updates the markdown for man pages of `docker container ...`
so that they are consistent. The changes are based on feedback:
https://github.com/docker/docker/pull/30645#discussion_r99020188
https://github.com/docker/docker/pull/30645#discussion_r99020304

1. Use `H2 (##)` as needed
2. Use unrpiviledged prompt (`$`) instead of (`#`)

This PR convers files under man/src/container/*.md

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
Upstream-commit: b8b156f343
Component: cli

2017-06-02 00:10:52 +00:00

src

Make markdown for man pages of docker container ... consistent

2017-06-02 00:10:52 +00:00

docker-build.1.md

[docs,man] Fixed typo (#29516 )

2017-06-02 00:10:45 +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

Allow adding rules to cgroup devices.allow on container create/run

2017-06-02 00:10:51 +00:00

docker.1.md

Update the manuals of docker and dockerd

2017-06-02 00:10:46 +00:00

dockerd.8.md

Add daemon option --default-shm-size

2017-06-02 00:10:52 +00:00

Dockerfile

project: use vndr for vendoring

2017-06-02 00:10:32 +00:00

Dockerfile.5.md

Convert Unused ARG error to warning

2017-06-02 00:10:31 +00:00

Dockerfile.aarch64

project: use vndr for vendoring

2017-06-02 00:10:32 +00:00

Dockerfile.armhf

project: use vndr for vendoring

2017-06-02 00:10:32 +00:00

Dockerfile.ppc64le

project: use vndr for vendoring

2017-06-02 00:10:32 +00:00

Dockerfile.s390x

project: use vndr for vendoring

2017-06-02 00:10:32 +00:00

generate.go

Add example for device-cgroup-rule to man

2017-06-02 00:10:51 +00:00

generate.sh

Read long description from a file.

2017-06-02 00:10:47 +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

Moving man pages out of docs

2017-06-02 00:06:57 +00:00

README.md

Make README less scabious

2017-06-02 00:10:02 +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