manpages
Signed-off-by: mohitjain1911 <mohitjain19113@gmail.com>
Manpages: Added --filter examples to podman-stop.1.md.in
Signed-off-by: mohitjain1911 <mohitjain19113@gmail.com>
Manpages: Added examples for --filter flag for 'podman start' command in podman-start.1.md.in
Signed-off-by: mohitjain1911 <mohitjain19113@gmail.com>
Manpages: Added examples for --filter flag for 'podman rm' command in podman-rm.1.md.in
Signed-off-by: mohitjain1911 <mohitjain19113@gmail.com>
Manpages: Added examples for --filter flag for 'podman restart' command in podman-restart.1.md.in
Signed-off-by: mohitjain1911 <mohitjain19113@gmail.com>
Manpages: Added examples for --filter flag for 'podman pod ps' command in podman-pod-ps.1.md.in
Signed-off-by: mohitjain1911 <mohitjain19113@gmail.com>
Manpages: Added examples for --filter flag for 'podman system prune' command in podman-system-prune.1.md
Signed-off-by: mohitjain1911 <mohitjain19113@gmail.com>
Previously, the 'initialized' state was not documented as an available
filter for various Podman commands.
This commit documents 'initialized' as a valid state that can be used to
filter the start, stop, restart, rm, pause, unpause, and ps commands.
Fixes: #25017
Signed-off-by: Riccardo Paolo Bestetti <pbl@bestov.io>
On Mac and Windows systems the --latest option is not supported
this PR mentions this fact in the examples section of the man page.
Also added documentation and consistency to the man pages examples
sections.
Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
For all commands with a --filter option, cross-reference
against man pages, and vice-versa.
I'm sorry. I know this script has gone off the deep end.
[NO NEW TESTS NEEDED] although actually I would like to test some broken completions
Signed-off-by: Ed Santiago <santiago@redhat.com>
For filter=id=XXX (containers, pods) and =ctr-ids=XXX (pods):
if XXX is only hex characters, treat it as a PREFIX
otherwise, treat it as a REGEX
Add tests. Update documentation. And fix an incorrect help message.
Fixes: #18471
Signed-off-by: Ed Santiago <santiago@redhat.com>
Remove the container/pod ID file along with the container/pod. It's
primarily used in the context of systemd and are not useful nor needed
once a container/pod has ceased to exist.
Fixes: #16387
Signed-off-by: Valentin Rothberg <vrothberg@redhat.com>
Only in container/pod stop/rm/restart man pages; the others
(volume-rm, network-rm, system-service) are too different to refactor.
Mostly an easy one, no manual reconciliation needed apart from
the pod-vs-container difference.
Signed-off-by: Ed Santiago <santiago@redhat.com>
There are two meanings: one writes a cidfile, the other reads.
Split into two .md files.
This can be reviewed with hack/markdown-preprocess-review .
The main differences you'll see are all in cidfile.read:
1) I use the <<subcommand>> feature. This works nicely for
kill, pause/unpause, and stop. It works less nicely for
rm, because the man page will show "...and rm the container"
(a human might prefer to see "REMOVE the container"). Given
the benefit of this cleanup, I think this is a fine tradeoff.
2) I choose to include the "multiple times" text even on man pages
where it wasn't present before. I tested to make sure it works.
3) The #### line I choose is IMHO the best one.
Minor differences:
* I believe the "remove the container" text in podman-kill
and podman-stop is a copy/paste error. This PR fixes it.
* The only differences between the cidfile.write texts is
the #### line (my version is best) and a final period.
Signed-off-by: Ed Santiago <santiago@redhat.com>
