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-pod.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-pod.1.md')
| -rw-r--r-- | docs/podman-pod.1.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/podman-pod.1.md b/docs/podman-pod.1.md index 8f8403a40..1846d0411 100644 --- a/docs/podman-pod.1.md +++ b/docs/podman-pod.1.md @@ -19,7 +19,7 @@ podman pod is a set of subcommands that manage pods, or groups of containers. | kill | [podman-pod-kill(1)](podman-pod-kill.1.md) | Kill the main process of each container in pod. | | pause | [podman-pod-pause(1)](podman-pod-pause.1.md) | Pause one or more pods. | | ps | [podman-pod-ps(1)](podman-pod-ps.1.md) | Prints out information about pods. | -| restart | [podman-pod-restart(1)](podman-pod-restart.1.md) | Restart one or mode pods. | +| restart | [podman-pod-restart(1)](podman-pod-restart.1.md) | Restart one or more pods. | | rm | [podman-pod-rm(1)](podman-pod-rm.1.md) | Remove one or more pods. | | start | [podman-pod-start(1)](podman-pod-start.1.md) | Start one or more pods. | | stats | [podman-pod-stats(1)](podman-pod-stats.1.md) | Display live stream resource usage stats for containers in one or more pods. | |