diff mbox series

[v2,1/5] tools/build-docs-container: move container files in their own directory

Message ID 20251211-build-docs-container-tlmgr-v2-1-58719c103a50@bootlin.com
State Under Review
Headers show
Series Add missing CentOS Stream / RockyLinux distros to the system-requirements.rst doc | expand

Commit Message

Antonin Godard Dec. 11, 2025, 9:06 a.m. UTC
Create a directory to hold the Containerfiles as they were lying next to
the scripts. Change the build context of the docker build command to
build from SCRIPT_DIR and pass the host packages scripts and container
file relative to it.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/tools/build-docs-container                    | 13 ++++++-------
 .../tools/{ => containerfiles}/Containerfile.almalinux      |  0
 documentation/tools/{ => containerfiles}/Containerfile.apt  |  0
 .../tools/{ => containerfiles}/Containerfile.debian         |  0
 documentation/tools/{ => containerfiles}/Containerfile.dnf  |  0
 .../tools/{ => containerfiles}/Containerfile.fedora         |  0
 .../tools/{ => containerfiles}/Containerfile.ubuntu         |  0
 .../tools/{ => containerfiles}/Containerfile.zypper         |  0
 8 files changed, 6 insertions(+), 7 deletions(-)

Comments

Quentin Schulz Dec. 11, 2025, 12:26 p.m. UTC | #1
Hi Antonin,

On 12/11/25 10:06 AM, Antonin Godard via lists.yoctoproject.org wrote:
> Create a directory to hold the Containerfiles as they were lying next to
> the scripts. Change the build context of the docker build command to
> build from SCRIPT_DIR and pass the host packages scripts and container
> file relative to it.
> 

It's unclear what this helps with. (I'm assuming this could be a remnant 
from last version's ENTRYPOINT support attempt?).

> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> ---
>   documentation/tools/build-docs-container                    | 13 ++++++-------
>   .../tools/{ => containerfiles}/Containerfile.almalinux      |  0
>   documentation/tools/{ => containerfiles}/Containerfile.apt  |  0
>   .../tools/{ => containerfiles}/Containerfile.debian         |  0
>   documentation/tools/{ => containerfiles}/Containerfile.dnf  |  0
>   .../tools/{ => containerfiles}/Containerfile.fedora         |  0
>   .../tools/{ => containerfiles}/Containerfile.ubuntu         |  0
>   .../tools/{ => containerfiles}/Containerfile.zypper         |  0
>   8 files changed, 6 insertions(+), 7 deletions(-)
> 
> diff --git a/documentation/tools/build-docs-container b/documentation/tools/build-docs-container
> index b91a6daa9..7d25b15b9 100755
> --- a/documentation/tools/build-docs-container
> +++ b/documentation/tools/build-docs-container
> @@ -23,7 +23,6 @@ set -eu -o pipefail
>   SCRIPT_DIR=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &>/dev/null && pwd)
>   CONTAINERCMD=${CONTAINERCMD:-docker}
>   DOCS_DIR="$SCRIPT_DIR/../.."
> -SH_DIR="$SCRIPT_DIR/host_packages_scripts"
>   INCLUDE_ESSENTIAL_PACKAGES=${INCLUDE_ESSENTIAL_PACKAGES:-0}
>   
>   function usage()
> @@ -140,12 +139,12 @@ main ()
>       --tag "yocto-docs-$sanitized_dockername:latest" \
>       --build-arg ARG_FROM="docker.io/$image" \
>       --build-arg INCLUDE_ESSENTIAL_PACKAGES="${INCLUDE_ESSENTIAL_PACKAGES}" \
> -    --build-arg ESSENTIAL="$essential" \
> -    --build-arg DOCS="$docs" \
> -    --build-arg DOCS_PDF="$docs_pdf" \
> -    --build-arg PIP3="${pip3:-}" \
> -    --file "$SCRIPT_DIR/$containerfile" \
> -    "$SH_DIR/"
> +    --build-arg ESSENTIAL="host_packages_scripts/$essential" \
> +    --build-arg DOCS="host_packages_scripts/$docs" \
> +    --build-arg DOCS_PDF="host_packages_scripts/$docs_pdf" \
> +    --build-arg PIP3="host_packages_scripts/${pip3:-}" \
> +    --file "$SCRIPT_DIR/containerfiles/$containerfile" \
> +    "$SCRIPT_DIR"
>   

This seems to be doing two things: moving Containerfile.* into a subdir 
containerfiles and changing the context dir from SH_DIR to SCRIPT_DIR. 
Is there a reason they are both done in the same commit? Is the latter 
really necessary (I'm not sure it helps in terms of readability?).

Looks ok otherwise.

Cheers,
Quentin
diff mbox series

Patch

diff --git a/documentation/tools/build-docs-container b/documentation/tools/build-docs-container
index b91a6daa9..7d25b15b9 100755
--- a/documentation/tools/build-docs-container
+++ b/documentation/tools/build-docs-container
@@ -23,7 +23,6 @@  set -eu -o pipefail
 SCRIPT_DIR=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &>/dev/null && pwd)
 CONTAINERCMD=${CONTAINERCMD:-docker}
 DOCS_DIR="$SCRIPT_DIR/../.."
-SH_DIR="$SCRIPT_DIR/host_packages_scripts"
 INCLUDE_ESSENTIAL_PACKAGES=${INCLUDE_ESSENTIAL_PACKAGES:-0}
 
 function usage()
@@ -140,12 +139,12 @@  main ()
     --tag "yocto-docs-$sanitized_dockername:latest" \
     --build-arg ARG_FROM="docker.io/$image" \
     --build-arg INCLUDE_ESSENTIAL_PACKAGES="${INCLUDE_ESSENTIAL_PACKAGES}" \
-    --build-arg ESSENTIAL="$essential" \
-    --build-arg DOCS="$docs" \
-    --build-arg DOCS_PDF="$docs_pdf" \
-    --build-arg PIP3="${pip3:-}" \
-    --file "$SCRIPT_DIR/$containerfile" \
-    "$SH_DIR/"
+    --build-arg ESSENTIAL="host_packages_scripts/$essential" \
+    --build-arg DOCS="host_packages_scripts/$docs" \
+    --build-arg DOCS_PDF="host_packages_scripts/$docs_pdf" \
+    --build-arg PIP3="host_packages_scripts/${pip3:-}" \
+    --file "$SCRIPT_DIR/containerfiles/$containerfile" \
+    "$SCRIPT_DIR"
 
   local -a args_run=(
     --rm
diff --git a/documentation/tools/Containerfile.almalinux b/documentation/tools/containerfiles/Containerfile.almalinux
similarity index 100%
rename from documentation/tools/Containerfile.almalinux
rename to documentation/tools/containerfiles/Containerfile.almalinux
diff --git a/documentation/tools/Containerfile.apt b/documentation/tools/containerfiles/Containerfile.apt
similarity index 100%
rename from documentation/tools/Containerfile.apt
rename to documentation/tools/containerfiles/Containerfile.apt
diff --git a/documentation/tools/Containerfile.debian b/documentation/tools/containerfiles/Containerfile.debian
similarity index 100%
rename from documentation/tools/Containerfile.debian
rename to documentation/tools/containerfiles/Containerfile.debian
diff --git a/documentation/tools/Containerfile.dnf b/documentation/tools/containerfiles/Containerfile.dnf
similarity index 100%
rename from documentation/tools/Containerfile.dnf
rename to documentation/tools/containerfiles/Containerfile.dnf
diff --git a/documentation/tools/Containerfile.fedora b/documentation/tools/containerfiles/Containerfile.fedora
similarity index 100%
rename from documentation/tools/Containerfile.fedora
rename to documentation/tools/containerfiles/Containerfile.fedora
diff --git a/documentation/tools/Containerfile.ubuntu b/documentation/tools/containerfiles/Containerfile.ubuntu
similarity index 100%
rename from documentation/tools/Containerfile.ubuntu
rename to documentation/tools/containerfiles/Containerfile.ubuntu
diff --git a/documentation/tools/Containerfile.zypper b/documentation/tools/containerfiles/Containerfile.zypper
similarity index 100%
rename from documentation/tools/Containerfile.zypper
rename to documentation/tools/containerfiles/Containerfile.zypper