containers
/
podman
mirror of https://github.com/containers/podman.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
podman/docs/source/markdown
History
Ed Santiago 3d1bff6db9 man page cross-reference fixes: part 2 
The other direction: fix or clean up elements documented in
man pages but which did/do not exist in actual podman:

  * runlabel: add missing "-n" alias for --name

And, remove man page entries for nonexistent options:

  * podman commit: --iidfile
  * podman container runlabel: --rootfs, --storage
  * podman create: --cpu-count

There are two problems I don't know how to deal with. Both
are related to main_local.go:rootCmd.PersistentFlags() :

  1) podman-build.1.md documents --cni-config-dir and
     --runtime options, but these are not actually options
     under podman build; they are global options. The
     documentation in this man page differs from that
     under podman-build.

  2) podman ps implements a binary --namespace option,
     but this option does not (cannot?) appear in --help
     because there's a global --namespace string option
     and Cobra somehow gets confused about this.

Do we really intend for global options to be parsed on
the right-hand side of subcommands? This strikes me as
unintuitive and potentially confusing, although the
fact that it has taken me this long to discover it
suggests that it's not _that_ confusing.

Suggestions welcome. I can file issues for 1/2 above,
or simply teach my script to special-case ignore them.

Signed-off-by: Ed Santiago <santiago@redhat.com>
 		2020-03-11 11:05:37 -06:00
..
links Add `untag` sub-command 2020-01-08 10:06:10 +01:00
containers-mounts.conf.5.md [docs] Ensure we include section 5 documentation 2019-11-02 13:48:47 +01:00
libpod.conf.5.md libpod.conf: clarify `label` description 2020-02-19 11:04:02 +01:00
podman-attach.1.md Allow users to disable detach keys 2019-11-05 14:10:43 -05:00
podman-build.1.md man pages: fix inconsistencies 2020-03-10 15:03:59 -06:00
podman-commit.1.md man page cross-reference fixes: part 2 2020-03-11 11:05:37 -06:00
podman-container-checkpoint.1.md man pages: fix inconsistencies 2020-03-10 15:03:59 -06:00
podman-container-cleanup.1.md man pages: fix inconsistencies 2020-03-10 15:03:59 -06:00
podman-container-exists.1.md docs: remove reference to "sudo" in "podman exists" examples 2020-01-26 12:43:26 -05:00
podman-container-prune.1.md man pages: fix inconsistencies 2020-03-10 15:03:59 -06:00
podman-container-restore.1.md man pages: fix inconsistencies 2020-03-10 15:03:59 -06:00
podman-container-runlabel.1.md man page cross-reference fixes: part 2 2020-03-11 11:05:37 -06:00
podman-container.1.md Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
podman-cp.1.md Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
podman-create.1.md man page cross-reference fixes: part 2 2020-03-11 11:05:37 -06:00
podman-diff.1.md Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
podman-events.1.md Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
podman-exec.1.md Cleanup man pages exit code descriptions 2020-01-26 08:53:52 +01:00
podman-export.1.md Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
podman-generate-kube.1.md Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
podman-generate-systemd.1.md generate systemd: add `default.target` to INSTALL 2020-03-09 13:33:09 +01:00
podman-generate.1.md Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
podman-healthcheck-run.1.md Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
podman-healthcheck.1.md Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
podman-history.1.md docs: add boolean values and defaults to "man podman-history" options 2020-01-26 14:13:54 -05:00
podman-image-exists.1.md docs: remove reference to "sudo" in "podman exists" examples 2020-01-26 12:43:26 -05:00
podman-image-prune.1.md man pages: fix inconsistencies 2020-03-10 15:03:59 -06:00
podman-image-sign.1.md codespell: spelling corrections 2019-11-13 08:15:00 +11:00
podman-image-tree.1.md Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
podman-image-trust.1.md (minor) fix broken links to container-policy.json.5 2020-01-06 08:34:56 -07:00
podman-image.1.md Add `untag` sub-command 2020-01-08 10:06:10 +01:00
podman-images.1.md man pages: fix inconsistencies 2020-03-10 15:03:59 -06:00
podman-import.1.md Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
podman-info.1.md podman info man: example update 2019-12-12 19:55:03 -03:00
podman-init.1.md Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
podman-inspect.1.md markdown: reword 'podman-inspect' to properly explain '--size' 2020-01-22 10:02:06 -05:00
podman-kill.1.md man pages: fix inconsistencies 2020-03-10 15:03:59 -06:00
podman-load.1.md Allow users to set TMPDIR environment 2020-03-06 10:21:37 -05:00
podman-login.1.md fix mandatory parameter in login/logout 2020-02-18 15:30:49 -05:00
podman-logout.1.md fix mandatory parameter in login/logout 2020-02-18 15:30:49 -05:00
podman-logs.1.md man pages: fix inconsistencies 2020-03-10 15:03:59 -06:00
podman-mount.1.md man pages: fix inconsistencies 2020-03-10 15:03:59 -06:00
podman-network-create.1.md man pages: fix inconsistencies 2020-03-10 15:03:59 -06:00
podman-network-inspect.1.md Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
podman-network-ls.1.md Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
podman-network-rm.1.md Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
podman-network.1.md Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
podman-pause.1.md Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
podman-play-kube.1.md play kube: make seccomp handling better conform to k8s 2020-01-03 13:27:17 -05:00
podman-play.1.md Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
podman-pod-create.1.md man pages: fix inconsistencies 2020-03-10 15:03:59 -06:00
podman-pod-exists.1.md Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
podman-pod-inspect.1.md Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
podman-pod-kill.1.md Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
podman-pod-pause.1.md Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
podman-pod-prune.1.md man pages: fix inconsistencies 2020-03-10 15:03:59 -06:00
podman-pod-ps.1.md man pages: fix inconsistencies 2020-03-10 15:03:59 -06:00
podman-pod-restart.1.md Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
podman-pod-rm.1.md Remove containers when pruning a stopped pod. 2019-11-26 13:19:31 -05:00
podman-pod-start.1.md Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
podman-pod-stats.1.md Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
podman-pod-stop.1.md man pages: fix inconsistencies 2020-03-10 15:03:59 -06:00
podman-pod-top.1.md docs: update podman-{pod-,}top man pages 2019-12-11 10:50:27 +01:00
podman-pod-unpause.1.md Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
podman-pod.1.md Remove containers when pruning a stopped pod. 2019-11-26 13:19:31 -05:00
podman-port.1.md Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
podman-ps.1.md podman-ps: support image IDs 2020-02-17 15:22:21 +01:00
podman-pull.1.md Allow users to set TMPDIR environment 2020-03-06 10:21:37 -05:00
podman-push.1.md Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
podman-remote.1.md docs: replace '~' with $HOME in markdown as '~' isn't rendered properly 2020-01-28 12:56:55 -05:00
podman-remote.conf.5.md [docs] Ensure we include section 5 documentation 2019-11-02 13:48:47 +01:00
podman-restart.1.md man pages: fix inconsistencies 2020-03-10 15:03:59 -06:00
podman-rm.1.md Merge pull request #4974 from rhatdan/man 2020-01-28 03:28:18 -08:00
podman-rmi.1.md man pages: fix inconsistencies 2020-03-10 15:03:59 -06:00
podman-run.1.md man pages: fix inconsistencies 2020-03-10 15:03:59 -06:00
podman-save.1.md Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
podman-search.1.md Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
podman-start.1.md Allow users to disable detach keys 2019-11-05 14:10:43 -05:00
podman-stats.1.md Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
podman-stop.1.md docs: add missing hyphen for '-t' option, command '$' prompts 2020-01-28 05:31:52 -05:00
podman-system-df.1.md markdown: fix erroneous asterisk markup for options 2020-01-30 06:44:33 -05:00
podman-system-migrate.1.md markdown: fix formatting/content typos in migrate man page 2020-01-22 06:16:12 -05:00
podman-system-prune.1.md docs: fix system-prune markdown; reword for clarity 2020-01-26 07:46:21 -05:00
podman-system-renumber.1.md Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
podman-system-reset.1.md Add podman system reset command 2019-11-29 05:34:52 -05:00
podman-system-service.1.md doc: Fix examples for 'podman system service' 2020-02-10 16:26:27 +01:00
podman-system.1.md Move podman-service to podman-system-service 2020-02-06 13:41:57 -05:00
podman-tag.1.md Update `tag` documentation regarding 'alias' usage 2020-01-17 08:51:36 +01:00
podman-top.1.md docs: update podman-{pod-,}top man pages 2019-12-11 10:50:27 +01:00
podman-umount.1.md Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
podman-unpause.1.md Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
podman-unshare.1.md markdown: fix grammar/formatting, standardize on markdown 2020-01-23 06:59:21 -05:00
podman-untag.1.md Add `untag` sub-command 2020-01-08 10:06:10 +01:00
podman-varlink.1.md Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
podman-version.1.md Fix podman-remote version to print client and server 2019-12-02 15:50:00 +01:00
podman-volume-create.1.md man pages: fix inconsistencies 2020-03-10 15:03:59 -06:00
podman-volume-inspect.1.md man pages: fix inconsistencies 2020-03-10 15:03:59 -06:00
podman-volume-ls.1.md man pages: fix inconsistencies 2020-03-10 15:03:59 -06:00
podman-volume-prune.1.md Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
podman-volume-rm.1.md Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
podman-volume.1.md Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
podman-wait.1.md Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
podman.1.md docs: clarify that --syslog expects an argument 2020-03-10 08:33:39 +01:00