podman/docs/source
Ed Santiago dbe0e67897 Man pages: tighter documenting of --format fields
Initial impetus was #20958 (ps --format .Label abc). This is
a complicated solution to a simple-seeming problem.

The problem: .Label is a cobra *function*, something I did not
know about nor handle.

Solution: recognize cobra functions. Switch to __complete,
not __completeNoDesc, so we can see the number of arguments
required. Invent new man-page format for documenting functions.
And, finally, start enforcing how functions (and cobra structs)
are documented.

This discovered a never-used completion function, .Recycle(),
in podman-events. Remove it.

[NO NEW TESTS NEEDED] - the .go change is an excision of dead code.

Signed-off-by: Ed Santiago <santiago@redhat.com>
2024-01-15 13:11:27 -07:00
..
_static Show API doc for several versions 2022-02-09 18:17:52 +01:00
locale/ja/LC_MESSAGES Use single persistent ssh key for all machines 2024-01-04 23:47:49 -05:00
markdown Man pages: tighter documenting of --format fields 2024-01-15 13:11:27 -07:00
Commands.rst man pages and command help: clean up descriptions 2023-05-28 18:57:43 +02:00
Introduction.rst Fix broken code block markup in Introduction.rst 2023-10-26 18:51:45 +08:00
Reference.rst [CI:DOCS] update swagger version on docs.podman.io 2023-10-05 10:45:22 +02:00
Search.rst [CI:DOCS] Docs revamp. 2020-05-21 17:16:10 -04:00
Tutorials.rst [CI:DOCS] Tutorials.rst: add socket activation 2022-07-15 17:36:33 +02:00
conf.py Add Japanese locale and translation of index 2023-08-31 13:53:48 +09:00
includes.rst [CI:DOCS] Fix GitHub URL to Podman logo 2021-07-21 11:22:01 -04:00
index.rst [CI:DOCS] Add link to podman py docs 2023-11-17 07:18:59 -05:00
volume.rst volumes: Add volume import to allow importing contents on tar into volume 2021-08-26 14:14:14 +05:30