Merge pull request containers#20753 from edsantiago/farmbuild_docs_cl…

…eanup Clean up farm-build miscommit
n1hility · Nov 27, 2023 · 8e5e060 · 8e5e060
2 parents d1236f4 + f6b2a13
commit 8e5e060
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 9 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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',                         #  "    "  "      "