Guest24897
/
DockerCLI
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
DockerCLI/man
History
Yong Tang e450a54119 Change HumanSize to BytesSize for memory output in `docker stats`. 
This fix tries to fix the discrepancy between `docker stats` and
`docker run` where `docker run` uses RAMInBytes for all memory
related inputs but `docker stats` uses HumanSize for all memory
related outputs.

To be consistent, `docker stats` needs to use BytesSize for all
memory related outputs to conform to RAMInBytes in `docker run`.

This fix addresses this issue. As BytesSize is used, the test
cases needs to be adjusted to match `KiB/MiB/GiB` instead of
`KB/MB/GB`.

The documentation has also been updated.

This fix fixes #21765.

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
 		2017-06-02 00:07:35 +00:00
..
Dockerfile Bump go-md2man to 1.0.3 2017-06-02 00:07:02 +00:00
Dockerfile.5.md docs: userguide: labels-custom-metadsata.md: update syntax for emtpy value labels 2017-06-02 00:07:21 +00:00
README.md updates to readme documents for manual page 2017-06-02 00:07:09 +00:00
config-json.5.md docs: add $ before HOME 2017-06-02 00:07:31 +00:00
docker-attach.1.md Fix mention of at sign in docs 2017-06-02 00:07:28 +00:00
docker-build.1.md 1.change validateNoSchema into validateNoScheme 2017-06-02 00:07:35 +00:00
docker-commit.1.md Fix man and commandline docs 2017-06-02 00:07:11 +00:00
docker-cp.1.md Adds clarification to behavior of missing directories. 2017-06-02 00:07:31 +00:00
docker-create.1.md CLI flag for docker create(run) to change block device size. 2017-06-02 00:07:34 +00:00
docker-daemon.8.md docs for `docker daemon --containerd` 2017-06-02 00:07:34 +00:00
docker-diff.1.md Moving man pages out of docs 2017-06-02 00:06:57 +00:00
docker-events.1.md Fix some flaws in man. 2017-06-02 00:07:30 +00:00
docker-exec.1.md Fix docs 2017-06-02 00:07:29 +00:00
docker-export.1.md various man page typos 2017-06-02 00:07:12 +00:00
docker-history.1.md remove =false from options that default to false in the docs 2017-06-02 00:07:21 +00:00
docker-images.1.md Correct old virtual size 2017-06-02 00:07:27 +00:00
docker-import.1.md Fix some flaws in man. 2017-06-02 00:07:30 +00:00
docker-info.1.md Add insecure registries to docker info 2017-06-02 00:07:35 +00:00
docker-inspect.1.md Remove unneeded references to execDriver 2017-06-02 00:07:33 +00:00
docker-kill.1.md Fix man pages 2017-06-02 00:07:16 +00:00
docker-load.1.md add docs for `docker load --quiet` 2017-06-02 00:07:33 +00:00
docker-login.1.md Remove email address field from login 2017-06-02 00:07:30 +00:00
docker-logout.1.md Remove some references to "register" through login 2017-06-02 00:07:30 +00:00
docker-logs.1.md Fix some typos in comments and strings 2017-06-02 00:07:29 +00:00
docker-network-connect.1.md Improve wording about re-assigning IP addresses 2017-06-02 00:07:27 +00:00
docker-network-create.1.md docs for labels on build, networks and volumes 2017-06-02 00:07:33 +00:00
docker-network-disconnect.1.md Forced endpoint cleanup 2017-06-02 00:07:23 +00:00
docker-network-inspect.1.md Display `internal` flag on `network inspect` 2017-06-02 00:07:28 +00:00
docker-network-ls.1.md Fix some flaws in man. 2017-06-02 00:07:30 +00:00
docker-network-rm.1.md Fix some flaws in man. 2017-06-02 00:07:30 +00:00
docker-pause.1.md Moving man pages out of docs 2017-06-02 00:06:57 +00:00
docker-port.1.md Moving man pages out of docs 2017-06-02 00:06:57 +00:00
docker-ps.1.md Add mounts to docker ps. 2017-06-02 00:07:30 +00:00
docker-pull.1.md Mention "docker login" in push/pull documentation 2017-06-02 00:07:34 +00:00
docker-push.1.md Mention "docker login" in push/pull documentation 2017-06-02 00:07:34 +00:00
docker-rename.1.md various man page typos 2017-06-02 00:07:12 +00:00
docker-restart.1.md Fix man pages 2017-06-02 00:07:16 +00:00
docker-rm.1.md Fix some flaws in man. 2017-06-02 00:07:30 +00:00
docker-rmi.1.md remove =false from options that default to false in the docs 2017-06-02 00:07:21 +00:00
docker-run.1.md CLI flag for docker create(run) to change block device size. 2017-06-02 00:07:34 +00:00
docker-save.1.md Update 'save' command help 2017-06-02 00:07:32 +00:00
docker-search.1.md remove =false from options that default to false in the docs 2017-06-02 00:07:21 +00:00
docker-start.1.md Implement configurable detach key 2017-06-02 00:07:22 +00:00
docker-stats.1.md Change HumanSize to BytesSize for memory output in `docker stats`. 2017-06-02 00:07:35 +00:00
docker-stop.1.md Fix man pages 2017-06-02 00:07:16 +00:00
docker-tag.1.md Deprecate -f flag from docker tag 2017-06-02 00:07:18 +00:00
docker-top.1.md Improvement of docker top Man Page 2017-06-02 00:07:18 +00:00
docker-unpause.1.md Moving man pages out of docs 2017-06-02 00:06:57 +00:00
docker-update.1.md Update RestartPolicy of container 2017-06-02 00:07:29 +00:00
docker-version.1.md add --format flag to `docker version` 2017-06-02 00:07:01 +00:00
docker-volume-create.1.md docs for labels on build, networks and volumes 2017-06-02 00:07:33 +00:00
docker-volume-inspect.1.md update docker volume man pages 2017-06-02 00:07:08 +00:00
docker-volume-ls.1.md Add man change for volume filter 2017-06-02 00:07:34 +00:00
docker-volume-rm.1.md update docker volume man pages 2017-06-02 00:07:08 +00:00
docker-volume.1.md Add a parent man page for docker volumes command 2017-06-02 00:07:31 +00:00
docker-wait.1.md Moving man pages out of docs 2017-06-02 00:06:57 +00:00
docker.1.md When using systemd, pass expected cgroupsPath and cli options to runc. 2017-06-02 00:07:34 +00:00
md2man-all.sh Moving man pages out of docs 2017-06-02 00:06:57 +00:00

README.md

Docker Documentation

This directory contains the Docker user manual in the Markdown format. Do not edit the man pages in the man1 directory. Instead, amend the Markdown (*.md) files.

Generating man pages from the Markdown files

The recommended approach for generating the man pages is via a Docker container using the supplied Dockerfile to create an image with the correct environment. This uses go-md2man, a pure Go Markdown to man page generator.

Building the md2man image

There is a Dockerfile provided in the /man directory of your 'docker/docker' fork.

Using this Dockerfile, create a Docker image tagged docker/md2man:

docker build -t docker/md2man .

Utilizing the image

From within the /man directory run the following command:

docker run -v $(pwd):/man -w /man -i docker/md2man ./md2man-all.sh

The md2man Docker container will process the Markdown files and generate the man pages inside the /man/man1 directory of your fork using Docker volumes. For more information on Docker volumes see the man page for docker run and also look at the article [Sharing Directories via Volumes] (https://docs.docker.com/use/working_with_volumes/).