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 ++ 2 files changed, 4 insertions(+) create mode 100644 docs/source/markdown/options/arch.md (limited to 'docs/source/markdown/options') 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`. -- cgit v1.2.3-54-g00ecf