Merge pull request containers#15414 from edsantiago/docs_dedup_cidfile

Man pages: refactor common options: --cidfile
flouthoc · Aug 23, 2022 · d97f4df · d97f4df
2 parents 51d4b88 + 46f3136
commit d97f4df
Show file tree

Hide file tree

Showing 10 changed files with 19 additions and 21 deletions.
diff --git 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
@@ -0,0 +1,4 @@
+#### **--cidfile**=*file*
+
+Read container ID from the specified *file* and <<subcommand>> 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
@@ -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
@@ -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 → docs/source/markdown/podman-kill.1.md.in b/docs/source/markdown/podman-kill.1.md → 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 → docs/source/markdown/podman-pause.1.md.in b/docs/source/markdown/podman-pause.1.md → 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 → docs/source/markdown/podman-rm.1.md.in b/docs/source/markdown/podman-rm.1.md → 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
@@ -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 → docs/source/markdown/podman-stop.1.md.in b/docs/source/markdown/podman-stop.1.md → 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 → docs/source/markdown/podman-unpause.1.md.in b/docs/source/markdown/podman-unpause.1.md → 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*
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		#### --cidfile=file

		Write the container ID to file.