containers
/
podman
mirror of https://github.com/containers/podman.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
podman/docs
History
Ed Santiago beb71323b1 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>
 		2019-03-20 14:37:59 -06:00
..
links Add podman system prune and info commands 2019-02-05 10:41:55 -08:00
tutorials Replace skopeo-containers with containers-common 2019-03-14 09:01:30 -04:00
varlink Fix varlink remove image force 2018-05-11 16:05:10 +00:00
containers-mounts.conf.5.md docs: consistent headings 2018-08-30 16:51:56 +00:00
dckrman.sh Add support for mimicing docker CLI 2018-01-18 07:01:48 -05:00
generate.go Rename varlink socket and interface 2018-08-06 14:49:11 +00:00
libpod.conf.5.md libpod: allow to configure path to the network-cmd binary 2019-03-11 09:29:04 +01:00
play.png Initial checkin from CRI-O repo 2017-11-01 11:24:59 -04:00
podman-attach.1.md Corrected detach man pages and code comments 2019-03-13 14:16:37 -07:00
podman-build.1.md man pages - consistency fixes 2019-03-20 14:37:59 -06:00
podman-commit.1.md Add examples for Cobra 2019-02-14 15:03:11 -05:00
podman-container-checkpoint.1.md hide --latest on the remote-client 2019-02-22 14:13:08 -06:00
podman-container-cleanup.1.md Change exit code to 1 on podman rmi nosuch image 2019-02-25 12:49:27 -05:00
podman-container-exists.1.md man pages - consistency fixes 2019-03-20 14:37:59 -06:00
podman-container-prune.1.md man pages - consistency fixes 2019-03-20 14:37:59 -06:00
podman-container-restore.1.md hide --latest on the remote-client 2019-02-22 14:13:08 -06:00
podman-container-runlabel.1.md Add --replace flag to "podman container runlabel" 2019-03-13 13:16:49 -07:00
podman-container.1.md Fix link inconsistencies in man pages 2019-03-01 06:53:52 -07:00
podman-cp.1.md man pages - consistency fixes 2019-03-20 14:37:59 -06:00
podman-create.1.md Corrected detach man pages and code comments 2019-03-13 14:16:37 -07:00
podman-diff.1.md hide --latest on the remote-client 2019-02-22 14:13:08 -06:00
podman-events.1.md man pages - consistency fixes 2019-03-20 14:37:59 -06:00
podman-exec.1.md exec: support --preserve-fds 2019-03-02 11:45:42 +01:00
podman-export.1.md man pages - consistency fixes 2019-03-20 14:37:59 -06:00
podman-generate-kube.1.md man pages - consistency fixes 2019-03-20 14:37:59 -06:00
podman-generate.1.md man pages - consistency fixes 2019-03-20 14:37:59 -06:00
podman-healthcheck-run.1.md man pages - consistency fixes 2019-03-20 14:37:59 -06:00
podman-healthcheck.1.md man pages - consistency fixes 2019-03-20 14:37:59 -06:00
podman-history.1.md man pages - consistency fixes 2019-03-20 14:37:59 -06:00
podman-image-exists.1.md man pages - consistency fixes 2019-03-20 14:37:59 -06:00
podman-image-prune.1.md man pages - consistency fixes 2019-03-20 14:37:59 -06:00
podman-image-sign.1.md man pages - consistency fixes 2019-03-20 14:37:59 -06:00
podman-image-tree.1.md man pages - consistency fixes 2019-03-20 14:37:59 -06:00
podman-image-trust.1.md man pages - consistency fixes 2019-03-20 14:37:59 -06:00
podman-image.1.md man pages - consistency fixes 2019-03-20 14:37:59 -06:00
podman-images.1.md Add space between num & unit in images output 2018-11-12 14:06:31 -05:00
podman-import.1.md Better usage synopses for subcommands 2019-02-26 18:10:36 -07:00
podman-info.1.md Add podman system prune and info commands 2019-02-05 10:41:55 -08:00
podman-inspect.1.md Usability cleanup for 'inspect' 2019-03-13 08:29:52 -06:00
podman-kill.1.md hide --latest on the remote-client 2019-02-22 14:13:08 -06:00
podman-load.1.md Cleanup messages on podman load 2019-03-18 12:23:41 -04:00
podman-login.1.md --password-stdin flag in `podman login` 2019-02-14 10:09:25 -05:00
podman-logout.1.md Support auth file environment variable & add change to man pages 2018-10-12 10:05:14 -04:00
podman-logs.1.md display logs for multiple containers at the same time 2019-03-15 13:41:01 -05:00
podman-mount.1.md hide --latest on the remote-client 2019-02-22 14:13:08 -06:00
podman-pause.1.md Make kill, pause, and unpause parallel. 2018-11-01 14:23:55 -05:00
podman-play-kube.1.md man pages - consistency fixes 2019-03-20 14:37:59 -06:00
podman-play.1.md man pages - consistency fixes 2019-03-20 14:37:59 -06:00
podman-pod-create.1.md pod infra container is started before a container in a pod is run, started, or attached. 2019-02-15 16:39:24 -05:00
podman-pod-exists.1.md man pages - consistency fixes 2019-03-20 14:37:59 -06:00
podman-pod-inspect.1.md hide --latest on the remote-client 2019-02-22 14:13:08 -06:00
podman-pod-kill.1.md hide --latest on the remote-client 2019-02-22 14:13:08 -06:00
podman-pod-pause.1.md hide --latest on the remote-client 2019-02-22 14:13:08 -06:00
podman-pod-ps.1.md hide --latest on the remote-client 2019-02-22 14:13:08 -06:00
podman-pod-restart.1.md hide --latest on the remote-client 2019-02-22 14:13:08 -06:00
podman-pod-rm.1.md hide --latest on the remote-client 2019-02-22 14:13:08 -06:00
podman-pod-start.1.md hide --latest on the remote-client 2019-02-22 14:13:08 -06:00
podman-pod-stats.1.md Clean up man pages to match commands 2019-02-27 16:37:40 -05:00
podman-pod-stop.1.md hide --latest on the remote-client 2019-02-22 14:13:08 -06:00
podman-pod-top.1.md man pages - consistency fixes 2019-03-20 14:37:59 -06:00
podman-pod-unpause.1.md hide --latest on the remote-client 2019-02-22 14:13:08 -06:00
podman-pod.1.md man pages - consistency fixes 2019-03-20 14:37:59 -06:00
podman-port.1.md hide --latest on the remote-client 2019-02-22 14:13:08 -06:00
podman-ps.1.md output of port grouping in ps command added as example 2019-03-18 10:05:34 +09:00
podman-pull.1.md Add --all-tags to pull command 2019-02-09 20:00:19 -05:00
podman-push.1.md man pages - consistency fixes 2019-03-20 14:37:59 -06:00
podman-restart.1.md man pages - consistency fixes 2019-03-20 14:37:59 -06:00
podman-rm.1.md Change exit code to 1 on podman rm nosuch container 2019-02-25 10:31:04 -05:00
podman-rmi.1.md Change exit code to 1 on podman rmi nosuch image 2019-02-25 12:49:27 -05:00
podman-run.1.md Add CLI storage conf example to run manpage 2019-03-15 15:03:47 -04:00
podman-save.1.md Cleanup messages on podman load 2019-03-18 12:23:41 -04:00
podman-search.1.md Minimally update for the DockerInsecureSkipTLSVerify type change 2018-12-06 23:34:59 +01:00
podman-start.1.md Corrected detach man pages and code comments 2019-03-13 14:16:37 -07:00
podman-stats.1.md hide --latest on the remote-client 2019-02-22 14:13:08 -06:00
podman-stop.1.md hide --latest on the remote-client 2019-02-22 14:13:08 -06:00
podman-system-prune.1.md Add podman system prune and info commands 2019-02-05 10:41:55 -08:00
podman-system-renumber.1.md Do not make renumber shut down the runtime 2019-02-21 10:51:42 -05:00
podman-system.1.md Fix link inconsistencies in man pages 2019-03-01 06:53:52 -07:00
podman-tag.1.md docs: consistent format for example 2018-08-30 16:51:56 +00:00
podman-top.1.md hide --latest on the remote-client 2019-02-22 14:13:08 -06:00
podman-umount.1.md hide --latest on the remote-client 2019-02-22 14:13:08 -06:00
podman-unpause.1.md Make kill, pause, and unpause parallel. 2018-11-01 14:23:55 -05:00
podman-varlink.1.md docs: consistent format for example 2018-08-30 16:51:56 +00:00
podman-version.1.md Add support for short option -f in podman version 2019-01-30 15:41:52 +00:00
podman-volume-create.1.md Add "podman volume" command 2018-12-06 10:17:16 +00:00
podman-volume-inspect.1.md man pages - consistency fixes 2019-03-20 14:37:59 -06:00
podman-volume-ls.1.md Add "podman volume" command 2018-12-06 10:17:16 +00:00
podman-volume-prune.1.md man pages - consistency fixes 2019-03-20 14:37:59 -06:00
podman-volume-rm.1.md Add "podman volume" command 2018-12-06 10:17:16 +00:00
podman-volume.1.md Clean up man pages to match commands 2019-02-27 16:37:40 -05:00
podman-wait.1.md man pages - consistency fixes 2019-03-20 14:37:59 -06:00
podman.1.md man pages - consistency fixes 2019-03-20 14:37:59 -06:00