[Buildroot] [PATCH] Add documentation about docker registry

[Buildroot] [PATCH] Add documentation about docker registry

[Thierry GUIBERT via buildroot]

Signed-off-by: Thierry GUIBERT <thierry.guibert@croix-rouge.fr>
---
 docs/manual/adding-board-support.txt | 19 ++++++++++++++++---
 1 file changed, 16 insertions(+), 3 deletions(-)

diff --git a/docs/manual/adding-board-support.txt b/docs/manual/adding-board-support.txt
index cd90a5871f..f68e192468 100644
--- a/docs/manual/adding-board-support.txt
+++ b/docs/manual/adding-board-support.txt
@@ -48,9 +48,22 @@ and configurations in these directories, and reference them from the main
 Buildroot configuration. Refer to xref:customize[] for more details.
 
 Before submitting patches for new boards it is recommended to test it by
-building it using latest gitlab-CI docker container. To do this use
-utils/docker-run script and inside it issue these commands:
+building it using latest gitlab-CI docker container. 
+To do this use utils/docker-run script and inside it issue these commands:
 --------------------
- $ make +<boardname>_defconfig+
+ $ make <boardname>_defconfig
  $ make
 --------------------
+
+By defaut, buildroot developpers use our gitlab.com registry and it should
+be convenient for most usages. 
+If you still want to build your own docker images :
+--------------------
+ $ DOCKER_REGISTRY=registry.gitlab.com
+ $ IMAGE_NAME=buildroot.org/buildroot/base
+ $ IMAGE_TAG=YYYYMMDD.HHMM
+ $ docker build  --pull --no-cache \
+	-t ${DOCKER_REGISTRY}/${IMAGE_NAME}:${IMAGE_TAG} support/docker
+ $ docker push ${DOCKER_REGISTRY}/${IMAGE_NAME}:${IMAGE_TAG}
+--------------------
+
-- 
2.37.2

_______________________________________________
buildroot mailing list
buildroot@buildroot.org
https://lists.buildroot.org/mailman/listinfo/buildroot

Re: [Buildroot] [PATCH] Add documentation about docker registry

[Yann E. MORIN]

Thierry, All,

On 2022-09-04 15:46 +0200, Thierry GUIBERT via buildroot spake thusly:
> Signed-off-by: Thierry GUIBERT <thierry.guibert@croix-rouge.fr>
> ---
>  docs/manual/adding-board-support.txt | 19 ++++++++++++++++---
>  1 file changed, 16 insertions(+), 3 deletions(-)
> 
> diff --git a/docs/manual/adding-board-support.txt b/docs/manual/adding-board-support.txt
> index cd90a5871f..f68e192468 100644
> --- a/docs/manual/adding-board-support.txt
> +++ b/docs/manual/adding-board-support.txt
> @@ -48,9 +48,22 @@ and configurations in these directories, and reference them from the main
>  Buildroot configuration. Refer to xref:customize[] for more details.
>  
>  Before submitting patches for new boards it is recommended to test it by
> -building it using latest gitlab-CI docker container. To do this use
> -utils/docker-run script and inside it issue these commands:
> +building it using latest gitlab-CI docker container. 
> +To do this use utils/docker-run script and inside it issue these commands:
>  --------------------
> - $ make +<boardname>_defconfig+
> + $ make <boardname>_defconfig

Both spurious changes in this commit.

Still, there was clearly incorrect formatting, so I've fix that in a
followup commit, thanks.

>   $ make
>  --------------------
> +
> +By defaut, buildroot developpers use our gitlab.com registry and it should

s/defaut/default/
s/developpers/developers/

> +be convenient for most usages. 
> +If you still want to build your own docker images :
> +--------------------
> + $ DOCKER_REGISTRY=registry.gitlab.com
> + $ IMAGE_NAME=buildroot.org/buildroot/base
> + $ IMAGE_TAG=YYYYMMDD.HHMM
> + $ docker build  --pull --no-cache \
> +	-t ${DOCKER_REGISTRY}/${IMAGE_NAME}:${IMAGE_TAG} support/docker
> + $ docker push ${DOCKER_REGISTRY}/${IMAGE_NAME}:${IMAGE_TAG}
> +--------------------

I don't think it is very interesting to document how to build a local
image and push it to a registry; that's the basics of docker.

Instead, I've reworded to instruct people where to look for the offical
images, and that they can use it as the FROM directive in their
Dockerfile.

Applied to master with the above changes, thanks.

Regards,
Yann E. MORIN.

> +
> -- 
> 2.37.2
> 
> _______________________________________________
> buildroot mailing list
> buildroot@buildroot.org
> https://lists.buildroot.org/mailman/listinfo/buildroot

-- 
.-----------------.--------------------.------------------.--------------------.
|  Yann E. MORIN  | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: |
| +33 662 376 056 | Software  Designer | \ / CAMPAIGN     |  ___               |
| +33 561 099 427 `------------.-------:  X  AGAINST      |  \e/  There is no  |
| http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL    |   v   conspiracy.  |
'------------------------------^-------^------------------^--------------------'
_______________________________________________
buildroot mailing list
buildroot@buildroot.org
https://lists.buildroot.org/mailman/listinfo/buildroot