From 70a599b5717517d178cd2d4fce90e213e6abafaa Mon Sep 17 00:00:00 2001 From: Ed Santiago Date: Mon, 29 Aug 2022 15:05:50 -0600 Subject: [PATCH] Man pages: refactor common options: --signal Would've been an easy one, except I decided to fix the text to conform to our guidelines. I haven't been doing this, but in this case it's only two man pages and the text is short enough to make for easy review. Signed-off-by: Ed Santiago --- docs/source/markdown/.gitignore | 1 + docs/source/markdown/options/signal.md | 4 ++++ docs/source/markdown/podman-kill.1.md.in | 5 +---- .../{podman-pod-kill.1.md => podman-pod-kill.1.md.in} | 5 +---- 4 files changed, 7 insertions(+), 8 deletions(-) create mode 100644 docs/source/markdown/options/signal.md rename docs/source/markdown/{podman-pod-kill.1.md => podman-pod-kill.1.md.in} (90%) diff --git a/docs/source/markdown/.gitignore b/docs/source/markdown/.gitignore index 8a0d553ba7..26509612d5 100644 --- a/docs/source/markdown/.gitignore +++ b/docs/source/markdown/.gitignore @@ -15,6 +15,7 @@ podman-manifest-push.1.md podman-pause.1.md podman-pod-clone.1.md podman-pod-create.1.md +podman-pod-kill.1.md podman-pod-logs.1.md podman-pod-rm.1.md podman-pod-start.1.md diff --git a/docs/source/markdown/options/signal.md b/docs/source/markdown/options/signal.md new file mode 100644 index 0000000000..6e6c036573 --- /dev/null +++ b/docs/source/markdown/options/signal.md @@ -0,0 +1,4 @@ +#### **--signal**, **-s**=**signal** + +Signal to send to the container<<|s in the pod>>. For more information on Linux signals, refer to *signal(7)*. +The default is **SIGKILL**. diff --git a/docs/source/markdown/podman-kill.1.md.in b/docs/source/markdown/podman-kill.1.md.in index 2788cc6941..46d7f5c6b8 100644 --- a/docs/source/markdown/podman-kill.1.md.in +++ b/docs/source/markdown/podman-kill.1.md.in @@ -23,10 +23,7 @@ Signal all running and paused containers. Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) -#### **--signal**, **-s** - -Signal to send to the container. For more information on Linux signals, refer to *man signal(7)*. - +@@option signal ## EXAMPLE diff --git a/docs/source/markdown/podman-pod-kill.1.md b/docs/source/markdown/podman-pod-kill.1.md.in similarity index 90% rename from docs/source/markdown/podman-pod-kill.1.md rename to docs/source/markdown/podman-pod-kill.1.md.in index 96ced68a71..7f37661b06 100644 --- a/docs/source/markdown/podman-pod-kill.1.md +++ b/docs/source/markdown/podman-pod-kill.1.md.in @@ -19,10 +19,7 @@ Sends signal to all containers associated with a pod. Instead of providing the pod name or ID, use the last created pod. If you use methods other than Podman to run pods such as CRI-O, the last started pod could be from either of those methods. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) -#### **--signal**, **-s** - -Signal to send to the containers in the pod. For more information on Linux signals, refer to *man signal(7)*. - +@@option signal ## EXAMPLE