From 46f31361f88317d405d7f7b41c5d644328cd2e5b Mon Sep 17 00:00:00 2001 From: Ed Santiago Date: Mon, 22 Aug 2022 10:18:36 -0600 Subject: [PATCH] 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 <> 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 --- docs/source/markdown/.gitignore | 5 +++++ docs/source/markdown/options/cidfile.read.md | 4 ++++ docs/source/markdown/options/cidfile.write.md | 3 +++ docs/source/markdown/podman-create.1.md.in | 4 +--- .../markdown/{podman-kill.1.md => podman-kill.1.md.in} | 4 +--- .../markdown/{podman-pause.1.md => podman-pause.1.md.in} | 4 +--- docs/source/markdown/{podman-rm.1.md => podman-rm.1.md.in} | 4 +--- docs/source/markdown/podman-run.1.md.in | 4 +--- .../markdown/{podman-stop.1.md => podman-stop.1.md.in} | 4 +--- .../markdown/{podman-unpause.1.md => podman-unpause.1.md.in} | 4 +--- 10 files changed, 19 insertions(+), 21 deletions(-) create mode 100644 docs/source/markdown/options/cidfile.read.md create mode 100644 docs/source/markdown/options/cidfile.write.md rename docs/source/markdown/{podman-kill.1.md => podman-kill.1.md.in} (93%) rename docs/source/markdown/{podman-pause.1.md => podman-pause.1.md.in} (96%) rename docs/source/markdown/{podman-rm.1.md => podman-rm.1.md.in} (97%) rename docs/source/markdown/{podman-stop.1.md => podman-stop.1.md.in} (96%) rename docs/source/markdown/{podman-unpause.1.md => podman-unpause.1.md.in} (96%) diff --git a/docs/source/markdown/.gitignore b/docs/source/markdown/.gitignore index 70f1c2bd72..5a30aab78f 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 diff --git a/docs/source/markdown/options/cidfile.read.md b/docs/source/markdown/options/cidfile.read.md new file mode 100644 index 0000000000..414700fca3 --- /dev/null +++ b/docs/source/markdown/options/cidfile.read.md @@ -0,0 +1,4 @@ +#### **--cidfile**=*file* + +Read container ID from the specified *file* and <> the container. +Can be specified multiple times. diff --git a/docs/source/markdown/options/cidfile.write.md b/docs/source/markdown/options/cidfile.write.md new file mode 100644 index 0000000000..b5e7435b27 --- /dev/null +++ b/docs/source/markdown/options/cidfile.write.md @@ -0,0 +1,3 @@ +#### **--cidfile**=*file* + +Write the container ID to *file*. diff --git a/docs/source/markdown/podman-create.1.md.in b/docs/source/markdown/podman-create.1.md.in index 7ec4fc66fd..2827964f71 100644 --- a/docs/source/markdown/podman-create.1.md.in +++ b/docs/source/markdown/podman-create.1.md.in @@ -105,9 +105,7 @@ Block IO relative device weight. @@option chrootdirs -#### **--cidfile**=*id* - -Write the container ID to the file +@@option cidfile.write @@option conmon-pidfile diff --git a/docs/source/markdown/podman-kill.1.md b/docs/source/markdown/podman-kill.1.md.in similarity index 93% rename from docs/source/markdown/podman-kill.1.md rename to docs/source/markdown/podman-kill.1.md.in index a4f80ac81d..2788cc6941 100644 --- a/docs/source/markdown/podman-kill.1.md +++ b/docs/source/markdown/podman-kill.1.md.in @@ -16,9 +16,7 @@ The main process inside each container specified will be sent SIGKILL, or any si Signal all running and paused containers. -#### **--cidfile** - -Read container ID from the specified file and remove the container. Can be specified multiple times. +@@option cidfile.read #### **--latest**, **-l** diff --git a/docs/source/markdown/podman-pause.1.md b/docs/source/markdown/podman-pause.1.md.in similarity index 96% rename from docs/source/markdown/podman-pause.1.md rename to docs/source/markdown/podman-pause.1.md.in index f374d96f3d..af308f0344 100644 --- a/docs/source/markdown/podman-pause.1.md +++ b/docs/source/markdown/podman-pause.1.md.in @@ -17,9 +17,7 @@ Pauses all the processes in one or more containers. You may use container IDs o Pause all running containers. -#### **--cidfile** - -Read container ID from the specified file and pause the container. Can be specified multiple times. +@@option cidfile.read #### **--filter**, **-f**=*filter* diff --git a/docs/source/markdown/podman-rm.1.md b/docs/source/markdown/podman-rm.1.md.in similarity index 97% rename from docs/source/markdown/podman-rm.1.md rename to docs/source/markdown/podman-rm.1.md.in index 1dbd1d0c31..fa3031b295 100644 --- a/docs/source/markdown/podman-rm.1.md +++ b/docs/source/markdown/podman-rm.1.md.in @@ -18,9 +18,7 @@ Running or unusable containers will not be removed without the **-f** option. Remove all containers. Can be used in conjunction with **-f** as well. -#### **--cidfile** - -Read container ID from the specified file and remove the container. Can be specified multiple times. +@@option cidfile.read #### **--depend** diff --git a/docs/source/markdown/podman-run.1.md.in b/docs/source/markdown/podman-run.1.md.in index d10520e357..cdfa9366ad 100644 --- a/docs/source/markdown/podman-run.1.md.in +++ b/docs/source/markdown/podman-run.1.md.in @@ -120,9 +120,7 @@ each of **stdin**, **stdout**, and **stderr**. @@option chrootdirs -#### **--cidfile**=*file* - -Write the container ID to *file*. +@@option cidfile.write @@option conmon-pidfile diff --git a/docs/source/markdown/podman-stop.1.md b/docs/source/markdown/podman-stop.1.md.in similarity index 96% rename from docs/source/markdown/podman-stop.1.md rename to docs/source/markdown/podman-stop.1.md.in index cfc49afa1f..04fc9387f4 100644 --- a/docs/source/markdown/podman-stop.1.md +++ b/docs/source/markdown/podman-stop.1.md.in @@ -21,9 +21,7 @@ container and also via command line when creating the container. Stop all running containers. This does not include paused containers. -#### **--cidfile** - -Read container ID from the specified file and remove the container. Can be specified multiple times. +@@option cidfile.read #### **--filter**, **-f**=*filter* diff --git a/docs/source/markdown/podman-unpause.1.md b/docs/source/markdown/podman-unpause.1.md.in similarity index 96% rename from docs/source/markdown/podman-unpause.1.md rename to docs/source/markdown/podman-unpause.1.md.in index b94ace89ea..7bd46e1719 100644 --- a/docs/source/markdown/podman-unpause.1.md +++ b/docs/source/markdown/podman-unpause.1.md.in @@ -17,9 +17,7 @@ Unpauses the processes in one or more containers. You may use container IDs or Unpause all paused containers. -#### **--cidfile** - -Read container ID from the specified file and unpause the container. Can be specified multiple times. +@@option cidfile.read #### **--filter**, **-f**=*filter*