podman/docs/source
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
..
_static [CI:DOCS]Connect API docs and RTD 2020-01-17 15:12:35 -06:00
markdown man page cross-reference fixes: part 2 2020-03-11 11:05:37 -06:00
Commands.rst Enable pre-commit tool linting 2020-01-14 13:42:59 +00:00
Introduction.rst Restructure documentation dir 2019-10-31 12:31:39 -05:00
Reference.rst [CI:DOCS] Add logo and dev statement 2020-01-20 13:59:55 -06:00
Tutorials.rst Restructure documentation dir 2019-10-31 12:31:39 -05:00
conf.py Restructure documentation dir 2019-10-31 12:31:39 -05:00
generate.rst Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
healthcheck.rst Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
image.rst Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
index.rst Restructure documentation dir 2019-10-31 12:31:39 -05:00
managecontainers.rst Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
network.rst docs: fix incomplete heading underlining in network.rst 2020-01-28 06:44:07 -05:00
play.rst Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
pod.rst Remove containers when pruning a stopped pod. 2019-11-26 13:19:31 -05:00
system.rst Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
volume.rst Enable pre-commit tool linting 2020-01-14 13:42:59 +00:00