From 22f3dd4c29de5be5338bdd33a8adbd201e98790d Mon Sep 17 00:00:00 2001 From: Ed Santiago Date: Mon, 15 Aug 2022 12:31:30 -0600 Subject: Man pages: refactor common options: arch Smaller, more reviewable chunks. This is just one option, --arch. Future PRs may, if the reviewing is easy, include multiple options. This one includes fixes to the preprocessor script, though: * big oops, I was not handling '<>' where 'pod' appears other than the beginning of the string. * I was also not handling 'container<<| or pod>>', where one side was empty. * Behavior change: <>, on podman-pod-foo, becomes just 'foo' (not 'pod foo'). This will be useful in a future PR where we refactor --pod-id-file. Signed-off-by: Ed Santiago --- docs/source/markdown/options/README.md | 2 ++ docs/source/markdown/options/arch.md | 2 ++ docs/source/markdown/podman-create.1.md.in | 3 +-- docs/source/markdown/podman-pull.1.md.in | 3 +-- docs/source/markdown/podman-run.1.md.in | 3 +-- 5 files changed, 7 insertions(+), 6 deletions(-) create mode 100644 docs/source/markdown/options/arch.md (limited to 'docs/source') diff --git a/docs/source/markdown/options/README.md b/docs/source/markdown/options/README.md index b737fabf7..92f3d374e 100644 --- a/docs/source/markdown/options/README.md +++ b/docs/source/markdown/options/README.md @@ -42,3 +42,5 @@ This allows the shared use of examples in the option file: ``` Example: podman <> --foo --bar ``` +As a special case, `podman-pod-X` becomes just `X` (the "pod" is removed). +This makes the `pod-id-file` man page more useful. diff --git a/docs/source/markdown/options/arch.md b/docs/source/markdown/options/arch.md new file mode 100644 index 000000000..005197707 --- /dev/null +++ b/docs/source/markdown/options/arch.md @@ -0,0 +1,2 @@ +#### **--arch**=*ARCH* +Override the architecture, defaults to hosts, of the image to be pulled. For example, `arm`. diff --git a/docs/source/markdown/podman-create.1.md.in b/docs/source/markdown/podman-create.1.md.in index 5bb1dceca..45dfe304c 100644 --- a/docs/source/markdown/podman-create.1.md.in +++ b/docs/source/markdown/podman-create.1.md.in @@ -73,8 +73,7 @@ and specified with a _tag_. Add an annotation to the container. The format is key=value. The **--annotation** option can be set multiple times. -#### **--arch**=*ARCH* -Override the architecture, defaults to hosts, of the image to be pulled. For example, `arm`. +@@option arch #### **--attach**, **-a**=*location* diff --git a/docs/source/markdown/podman-pull.1.md.in b/docs/source/markdown/podman-pull.1.md.in index 4321cb364..29c4f865d 100644 --- a/docs/source/markdown/podman-pull.1.md.in +++ b/docs/source/markdown/podman-pull.1.md.in @@ -49,8 +49,7 @@ All tagged images in the repository will be pulled. *IMPORTANT: When using the all-tags flag, Podman will not iterate over the search registries in the **[containers-registries.conf(5)](https://github.com/containers/image/blob/main/docs/containers-registries.conf.5.md)** but will always use docker.io for unqualified image names.* -#### **--arch**=*ARCH* -Override the architecture, defaults to hosts, of the image to be pulled. For example, `arm`. +@@option arch #### **--authfile**=*path* diff --git a/docs/source/markdown/podman-run.1.md.in b/docs/source/markdown/podman-run.1.md.in index 21ce566ce..df9f1c28a 100644 --- a/docs/source/markdown/podman-run.1.md.in +++ b/docs/source/markdown/podman-run.1.md.in @@ -90,8 +90,7 @@ and specified with a _tag_. Add an annotation to the container. This option can be set multiple times. -#### **--arch**=*ARCH* -Override the architecture, defaults to hosts, of the image to be pulled. For example, `arm`. +@@option arch #### **--attach**, **-a**=*stdin* | *stdout* | *stderr* -- cgit v1.2.3-54-g00ecf