diff options
| author | Ed Santiago <santiago@redhat.com> | 2022-08-22 10:18:36 -0600 |
|---|---|---|
| committer | Ed Santiago <santiago@redhat.com> | 2022-08-22 12:17:20 -0600 |
| commit | 46f31361f88317d405d7f7b41c5d644328cd2e5b (patch) | |
| tree | 3b9a4afd32e106865422d4f777689804454a29a3 /docs/source/markdown/.gitignore | |
| parent | aefd0aed3990848e77b706d673c23108092594a0 (diff) | |
| download | podman-46f31361f88317d405d7f7b41c5d644328cd2e5b.tar.gz podman-46f31361f88317d405d7f7b41c5d644328cd2e5b.tar.bz2 podman-46f31361f88317d405d7f7b41c5d644328cd2e5b.zip | |
Man pages: refactor common options: --cidfile
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>
Diffstat (limited to 'docs/source/markdown/.gitignore')
| -rw-r--r-- | docs/source/markdown/.gitignore | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/source/markdown/.gitignore b/docs/source/markdown/.gitignore index 70f1c2bd7..5a30aab78 100644 --- a/docs/source/markdown/.gitignore +++ b/docs/source/markdown/.gitignore @@ -4,14 +4,19 @@ podman-container-clone.1.md podman-container-runlabel.1.md podman-create.1.md podman-image-sign.1.md +podman-kill.1.md podman-kube-play.1.md podman-login.1.md podman-logout.1.md podman-manifest-add.1.md podman-manifest-push.1.md +podman-pause.1.md podman-pod-clone.1.md podman-pod-create.1.md podman-pull.1.md podman-push.1.md +podman-rm.1.md podman-run.1.md podman-search.1.md +podman-stop.1.md +podman-unpause.1.md |