From f6b2a137810f13d3beabf0f38d20ab318115b191 Mon Sep 17 00:00:00 2001 From: Ed Santiago Date: Wed, 22 Nov 2023 13:22:51 -0700 Subject: [PATCH] Clean up farm-build miscommit Followup to #20051, which I didn't review in time. Signed-off-by: Ed Santiago --- docs/source/markdown/options/add-host.md | 2 +- docs/source/markdown/options/no-hostname.md | 9 +++++++++ docs/source/markdown/podman-build.1.md.in | 6 +----- docs/source/markdown/podman-farm-build.1.md.in | 6 +++++- docs/source/markdown/podman-farm-list.1.md | 2 +- hack/xref-helpmsgs-manpages | 2 +- 6 files changed, 18 insertions(+), 9 deletions(-) create mode 100644 docs/source/markdown/options/no-hostname.md diff --git a/docs/source/markdown/options/add-host.md b/docs/source/markdown/options/add-host.md index 968665d812..6e9f598ca0 100644 --- a/docs/source/markdown/options/add-host.md +++ b/docs/source/markdown/options/add-host.md @@ -1,5 +1,5 @@ ####> This option file is used in: -####> podman build, create, pod create, run +####> podman build, create, farm build, pod create, run ####> If file is edited, make sure the changes ####> are applicable to all of those. #### **--add-host**=*host:ip* diff --git a/docs/source/markdown/options/no-hostname.md b/docs/source/markdown/options/no-hostname.md new file mode 100644 index 0000000000..1cb4d8dfb6 --- /dev/null +++ b/docs/source/markdown/options/no-hostname.md @@ -0,0 +1,9 @@ +####> This option file is used in: +####> podman build, farm build +####> If file is edited, make sure the changes +####> are applicable to all of those. +#### **--no-hostname** + +Do not create the _/etc/hostname_ file in the container for RUN instructions. + +By default, Buildah manages the _/etc/hostname_ file, adding the container's own hostname. When the **--no-hostname** option is set, the image's _/etc/hostname_ will be preserved unmodified if it exists. diff --git a/docs/source/markdown/podman-build.1.md.in b/docs/source/markdown/podman-build.1.md.in index 26a0ea51e5..0e013dea9d 100644 --- a/docs/source/markdown/podman-build.1.md.in +++ b/docs/source/markdown/podman-build.1.md.in @@ -249,11 +249,7 @@ This option is not supported on the remote client, including Mac and Windows @@option no-cache -#### **--no-hostname** - -Do not create the _/etc/hostname_ file in the container for RUN instructions. - -By default, Buildah manages the _/etc/hostname_ file, adding the container's own hostname. When the **--no-hostname** option is set, the image's _/etc/hostname_ will be preserved unmodified if it exists. +@@option no-hostname @@option no-hosts diff --git a/docs/source/markdown/podman-farm-build.1.md.in b/docs/source/markdown/podman-farm-build.1.md.in index 64fd8a7c96..14ef252c89 100644 --- a/docs/source/markdown/podman-farm-build.1.md.in +++ b/docs/source/markdown/podman-farm-build.1.md.in @@ -19,6 +19,8 @@ If no farm is specified, the build will be sent out to all the nodes that `podma ## OPTIONS +@@option add-host + @@option annotation.image @@option authfile @@ -121,7 +123,7 @@ It does not affect _/etc/resolv.conf_ in the final image. @@option layers -#### **--local** +#### **--local**, **-l** Build image on local machine as well as on farm nodes. @@ -135,6 +137,8 @@ Build image on local machine as well as on farm nodes. @@option no-cache +@@option no-hostname + @@option no-hosts This option conflicts with **--add-host**. diff --git a/docs/source/markdown/podman-farm-list.1.md b/docs/source/markdown/podman-farm-list.1.md index c30a9ec545..e643bdc1a4 100644 --- a/docs/source/markdown/podman-farm-list.1.md +++ b/docs/source/markdown/podman-farm-list.1.md @@ -13,7 +13,7 @@ List all the existing farms. ## OPTIONS -#### **--format**, **-f**=*format* +#### **--format**=*format* Change the default output format. This can be of a supported type like 'json' or a Go template. Valid placeholders for the Go template listed below: diff --git a/hack/xref-helpmsgs-manpages b/hack/xref-helpmsgs-manpages index d8d32847ce..4b925737ea 100755 --- a/hack/xref-helpmsgs-manpages +++ b/hack/xref-helpmsgs-manpages @@ -85,7 +85,7 @@ for my $line (split "\n", $Format_Exceptions) { # added, with a --format option that does not autocomplete '{{.', # let's make sure it gets extra eyeballs. my %Format_Option_Is_Special = map { $_ => 1 } ( - 'build', 'image build', # oci | docker + 'build', 'farm build', 'image build', # oci | docker 'commit', 'container commit', # " " " " 'diff', 'container diff', 'image diff', # only supports "json" 'generate systemd', # " " " "