diff mbox series

docker.rst: Reword slightly around "buildx"

Message ID 20241115162649.2395503-1-trini@konsulko.com
State Superseded
Delegated to: Tom Rini
Headers show
Series docker.rst: Reword slightly around "buildx" | expand

Commit Message

Tom Rini Nov. 15, 2024, 4:26 p.m. UTC
Try and be slightly clearer about what "buildx" is, and how to install
it.

Signed-off-by: Tom Rini <trini@konsulko.com>
---
I rephrased this slightly to try and be clearer as if you're using the
docker.io provided packages you need to just install the plugin.

Cc: Simon Glass <sjg@chromium.org>
---
 doc/build/docker.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Tom Rini Nov. 15, 2024, 6:44 p.m. UTC | #1
On Fri, Nov 15, 2024 at 10:26:49AM -0600, Tom Rini wrote:
> Try and be slightly clearer about what "buildx" is, and how to install
> it.
> 
> Signed-off-by: Tom Rini <trini@konsulko.com>
> ---
> I rephrased this slightly to try and be clearer as if you're using the
> docker.io provided packages you need to just install the plugin.
> 
> Cc: Simon Glass <sjg@chromium.org>
> ---
>  doc/build/docker.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/doc/build/docker.rst b/doc/build/docker.rst
> index 5896dd5ac4a6..81b394597ffb 100644
> --- a/doc/build/docker.rst
> +++ b/doc/build/docker.rst
> @@ -4,8 +4,8 @@ GitLab CI / U-Boot runner container
>  In order to have a reproducible and portable build environment for CI we use a container for building in.  This means that developers can also reproduce the CI environment, to a large degree at least, locally.  This file is located in the tools/docker directory.
>  
>  The docker image supports both amd64 and arm64. Ensure that the
> -'docker-buildx' Debian package is installed (or the equivalent on another
> -distribution).
> +`buildx` Docker CLI plugin is installed. This is often available in your
> +distribution via the 'docker-buildx' or 'docker-buildx-plugin' package.
>  
>  You will need a multi-platform container, otherwise this error is shown::

And as a note to the future, understanding
https://docs.docker.com/build/building/multi-platform/ and a very quick
guide to how to practically add multiple nodes would likely be good. I
feel like most of the SBCs I have on-hand would be quicker than QEMU at
this part, and with actual arm64 builder in CI as well that's likely the
path forward.
diff mbox series

Patch

diff --git a/doc/build/docker.rst b/doc/build/docker.rst
index 5896dd5ac4a6..81b394597ffb 100644
--- a/doc/build/docker.rst
+++ b/doc/build/docker.rst
@@ -4,8 +4,8 @@  GitLab CI / U-Boot runner container
 In order to have a reproducible and portable build environment for CI we use a container for building in.  This means that developers can also reproduce the CI environment, to a large degree at least, locally.  This file is located in the tools/docker directory.
 
 The docker image supports both amd64 and arm64. Ensure that the
-'docker-buildx' Debian package is installed (or the equivalent on another
-distribution).
+`buildx` Docker CLI plugin is installed. This is often available in your
+distribution via the 'docker-buildx' or 'docker-buildx-plugin' package.
 
 You will need a multi-platform container, otherwise this error is shown::