summaryrefslogtreecommitdiff
path: root/API.md
diff options
context:
space:
mode:
authorEd Santiago <santiago@redhat.com>2020-03-11 10:55:45 -0600
committerEd Santiago <santiago@redhat.com>2020-03-11 11:05:37 -0600
commit3d1bff6db98ca5af0fad3f4effc379fcccc8664d (patch)
treef09ef6c65a1795117df2a0ec6ee6add35ad6dd9b /API.md
parent087fc79233f647cdbd4b4bc409c3bd8b02aedb13 (diff)
downloadpodman-3d1bff6db98ca5af0fad3f4effc379fcccc8664d.tar.gz
podman-3d1bff6db98ca5af0fad3f4effc379fcccc8664d.tar.bz2
podman-3d1bff6db98ca5af0fad3f4effc379fcccc8664d.zip
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>
Diffstat (limited to 'API.md')
0 files changed, 0 insertions, 0 deletions