diff options
| author | Ed Santiago <santiago@redhat.com> | 2019-03-20 08:15:56 -0600 |
|---|---|---|
| committer | Ed Santiago <santiago@redhat.com> | 2019-03-20 14:37:59 -0600 |
| commit | beb71323b1ffbb6efdce663ba9ba7719fa0709f5 (patch) | |
| tree | 4ab50d66769599e7d3e40a0e726a05c6e28fa38c /docs/podman-image.1.md | |
| parent | a7098485969095197059fe27f3d636a689f642fd (diff) | |
| download | podman-beb71323b1ffbb6efdce663ba9ba7719fa0709f5.tar.gz podman-beb71323b1ffbb6efdce663ba9ba7719fa0709f5.tar.bz2 podman-beb71323b1ffbb6efdce663ba9ba7719fa0709f5.zip | |
man pages - consistency fixes
podman-generate and -play had the wrong NAMEs.
podman-restart and -volume-prune the wrong SYNOPSIS.
All the rest are varying degrees of minor:
- missing a space between the NAME and description
- multi-line SYNOPSIS that could be collapsed into one
- use of UPPER CASE in synopsis instead of *asterisks*
- improper use of **double asterisks** for options
- varlink and version were transposed in podman-1
- fixed inconsistencies between the description in
the man page and that in the parent manpage. These
are too numerous for me to fix all.
Added: script that could be used in CI to prevent future
such inconsistencies. It cannot be enabled yet because
there are still 35+ inconsistencies in need of cleaning.
This will be difficult to review on github. I suggest
pulling the PR and running 'git log -1 -p | cdif | less'
'cdif' is a handy tool for colorizing individual diffs between
lines:
http://kaz-utashiro.github.io/cdif/
There are other such tools; use your favorite. Comparing
without visual highlights may be painful.
I also encourage you to run hack/man-page-checker and suggest
more fixes for the problems it's finding.
Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'docs/podman-image.1.md')
| -rw-r--r-- | docs/podman-image.1.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/podman-image.1.md b/docs/podman-image.1.md index 333a75b69..01cf08d62 100644 --- a/docs/podman-image.1.md +++ b/docs/podman-image.1.md @@ -14,13 +14,13 @@ The image command allows you to manage images | Command | Man Page | Description | | -------- | ----------------------------------------------- | --------------------------------------------------------------------------- | | build | [podman-build(1)](podman-build.1.md) | Build a container using a Dockerfile. | -| exists | [podman-image-exists(1)](podman-image-exists.1.md) | Check if a image exists in local storage. | +| exists | [podman-image-exists(1)](podman-image-exists.1.md) | Check if an image exists in local storage. | | history | [podman-history(1)](podman-history.1.md) | Show the history of an image. | | import | [podman-import(1)](podman-import.1.md) | Import a tarball and save it as a filesystem image. | | inspect | [podman-inspect(1)](podman-inspect.1.md) | Display a image or image's configuration. | | list | [podman-images(1)](podman-images.1.md) | List the container images on the system.(alias ls) | | load | [podman-load(1)](podman-load.1.md) | Load an image from the docker archive. | -| prune | [podman-image-prune(1)](podman-image-prune.1.md)| Removed all unused images from the local store. | +| prune | [podman-image-prune(1)](podman-image-prune.1.md)| Remove all unused images from the local store. | | pull | [podman-pull(1)](podman-pull.1.md) | Pull an image from a registry. | | push | [podman-push(1)](podman-push.1.md) | Push an image from local storage to elsewhere. | | rm | [podman-rmi(1)](podman-rmi.1.md) | Removes one or more locally stored images. | |