docker
/
cli
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
cli/man
History
Sebastiaan van Stijn 261d2241eb
docs, man: remove confusing example for "--isolation" 
This snippet was added in [docker@38ec5d8][1]. The intent was to indicate
that an empty value is equivalent to passing "default" as value. However,
passing the `--isolation` flag _without a value_ (i.e., no `=` specified)
will fail in many cases, as any string after it will be parsed as value
(e.g. `docker run --isolation busybox` would consider `busybox` as value).

This patch removes these lines as they add more confusion than addressing.

[1]: 38ec5d86a3

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 7b7a4c020e)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 		2025-01-03 18:41:59 +01:00
..
src docs, man: remove confusing example for "--isolation" 2025-01-03 18:41:59 +01:00
.gitignore validate manpages target 2022-02-25 17:11:17 +01:00
Dockerfile.5.md Correct typos in docs/ and man/ 2024-06-06 02:15:23 +00:00
README.md validate manpages target 2022-02-25 17:11:17 +01:00
docker-build.1.md docs, man: remove confusing example for "--isolation" 2025-01-03 18:41:59 +01:00
docker-config-json.5.md Update man-page source MarkDown to work with go-md2man v2 2020-10-20 12:21:15 +02:00
docker-run.1.md Permit '=' separator and '[ipv6]' in --add-host 2023-12-07 18:29:19 +00:00
docker.1.md Removed all mentions of "please" from docs and messages 2024-06-11 16:53:40 +02:00
dockerd.8.md man: dockerd: add description for --log-format option 2024-09-16 13:55:17 +02:00
generate.go gofmt with go1.17 2022-03-26 20:21:00 +01:00
go.mod update go-md2man to v2.0.5 2024-12-13 01:24:27 +01:00
tools.go gofmt with go1.17 2022-03-26 20:21:00 +01: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 -f docker.Makefile manpages