mirror of
https://github.com/containers/podman.git
synced 2025-12-05 21:10:35 +08:00
beb71323b1
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>
20 lines
762 B
Markdown
20 lines
762 B
Markdown
% podman-generate(1)
|
|
|
|
## NAME
|
|
podman\-generate - Generate structured data based for a containers and pods
|
|
|
|
## SYNOPSIS
|
|
**podman generate** *subcommand*
|
|
|
|
## DESCRIPTION
|
|
The generate command will create structured output (like YAML) based on a container or pod.
|
|
|
|
## COMMANDS
|
|
|
|
| Command | Man Page | Description |
|
|
| ------- | --------------------------------------------------- | ---------------------------------------------------------------------------- |
|
|
| kube | [podman-generate-kube(1)](podman-generate-kube.1.md)| Generate Kubernetes YAML based on a pod or container. |
|
|
|
|
## SEE ALSO
|
|
podman, podman-pod, podman-container
|