From d803bb3407577d4605d02abff0ef55f30dfc063e Mon Sep 17 00:00:00 2001 From: Ed Santiago Date: Tue, 3 Sep 2024 09:47:25 -0600 Subject: [PATCH] man pages: refactor two more options We're supposed to catch duplicate man-page options in review, but once in a while they sneak in. These are two dups that are 100% identical, and were auto-refactored by a script that I have. A few more options have snuck in (--dns, --usb) but those have different text so they can't be handled by my script. If anyone feels like refactoring those, go ahead. Signed-off-by: Ed Santiago --- docs/source/markdown/options/compat-auth-file.md | 7 +++++++ docs/source/markdown/options/sign-by-sigstore.md | 8 ++++++++ docs/source/markdown/podman-login.1.md.in | 4 +--- docs/source/markdown/podman-logout.1.md.in | 4 +--- docs/source/markdown/podman-manifest-push.1.md.in | 5 +---- docs/source/markdown/podman-push.1.md.in | 5 +---- 6 files changed, 19 insertions(+), 14 deletions(-) create mode 100644 docs/source/markdown/options/compat-auth-file.md create mode 100644 docs/source/markdown/options/sign-by-sigstore.md diff --git a/docs/source/markdown/options/compat-auth-file.md b/docs/source/markdown/options/compat-auth-file.md new file mode 100644 index 000000000000..ba377850486f --- /dev/null +++ b/docs/source/markdown/options/compat-auth-file.md @@ -0,0 +1,7 @@ +####> This option file is used in: +####> podman login, logout +####> If file is edited, make sure the changes +####> are applicable to all of those. +#### **--compat-auth-file**=*path* + +Instead of updating the default credentials file, update the one at *path*, and use a Docker-compatible format. diff --git a/docs/source/markdown/options/sign-by-sigstore.md b/docs/source/markdown/options/sign-by-sigstore.md new file mode 100644 index 000000000000..3ab4d7f0b4b0 --- /dev/null +++ b/docs/source/markdown/options/sign-by-sigstore.md @@ -0,0 +1,8 @@ +####> This option file is used in: +####> podman manifest push, push +####> If file is edited, make sure the changes +####> are applicable to all of those. +#### **--sign-by-sigstore**=*param-file* + +Add a sigstore signature based on further options specified in a container's sigstore signing parameter file *param-file*. +See containers-sigstore-signing-params.yaml(5) for details about the file format. diff --git a/docs/source/markdown/podman-login.1.md.in b/docs/source/markdown/podman-login.1.md.in index ad945734234c..09f37f7f1268 100644 --- a/docs/source/markdown/podman-login.1.md.in +++ b/docs/source/markdown/podman-login.1.md.in @@ -32,9 +32,7 @@ For more details about format and configurations of the auth.json file, see cont @@option cert-dir -#### **--compat-auth-file**=*path* - -Instead of updating the default credentials file, update the one at *path*, and use a Docker-compatible format. +@@option compat-auth-file #### **--get-login** diff --git a/docs/source/markdown/podman-logout.1.md.in b/docs/source/markdown/podman-logout.1.md.in index 36ba7173040f..33f43ca4fea2 100644 --- a/docs/source/markdown/podman-logout.1.md.in +++ b/docs/source/markdown/podman-logout.1.md.in @@ -27,9 +27,7 @@ Remove the cached credentials for all registries in the auth file @@option authfile -#### **--compat-auth-file**=*path* - -Instead of updating the default credentials file, update the one at *path*, and use a Docker-compatible format. +@@option compat-auth-file #### **--help**, **-h** diff --git a/docs/source/markdown/podman-manifest-push.1.md.in b/docs/source/markdown/podman-manifest-push.1.md.in index 8970fc46a878..c755fb02a4aa 100644 --- a/docs/source/markdown/podman-manifest-push.1.md.in +++ b/docs/source/markdown/podman-manifest-push.1.md.in @@ -64,10 +64,7 @@ Delete the manifest list or image index from local storage if pushing succeeds. Sign the pushed images with a “simple signing” signature using the specified key. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) -#### **--sign-by-sigstore**=*param-file* - -Add a sigstore signature based on further options specified in a container's sigstore signing parameter file *param-file*. -See containers-sigstore-signing-params.yaml(5) for details about the file format. +@@option sign-by-sigstore #### **--sign-by-sigstore-private-key**=*path* diff --git a/docs/source/markdown/podman-push.1.md.in b/docs/source/markdown/podman-push.1.md.in index add7c39fb621..f22aab8ec04b 100644 --- a/docs/source/markdown/podman-push.1.md.in +++ b/docs/source/markdown/podman-push.1.md.in @@ -92,10 +92,7 @@ Discard any pre-existing signatures in the image. Add a “simple signing” signature at the destination using the specified key. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) -#### **--sign-by-sigstore**=*param-file* - -Add a sigstore signature based on further options specified in a container's sigstore signing parameter file *param-file*. -See containers-sigstore-signing-params.yaml(5) for details about the file format. +@@option sign-by-sigstore #### **--sign-by-sigstore-private-key**=*path*