From 92b9df09abccd39085f9c22c5bab86ad05ff3a0e Mon Sep 17 00:00:00 2001
From: Tim <timchinowsky@gmail.com>
Date: Tue, 18 Jun 2024 09:55:38 -0700
Subject: [PATCH 1/5] add docker-build

---
 tools/docker-build/Dockerfile | 56 +++++++++++++++++++++++++++++++++++
 tools/docker-build/README.md  | 25 ++++++++++++++++
 tools/docker-build/build      |  9 ++++++
 tools/docker-build/build.sh   | 18 +++++++++++
 4 files changed, 108 insertions(+)
 create mode 100644 tools/docker-build/Dockerfile
 create mode 100644 tools/docker-build/README.md
 create mode 100755 tools/docker-build/build
 create mode 100644 tools/docker-build/build.sh

diff --git a/tools/docker-build/Dockerfile b/tools/docker-build/Dockerfile
new file mode 100644
index 000000000000..466a35972b71
--- /dev/null
+++ b/tools/docker-build/Dockerfile
@@ -0,0 +1,56 @@
+# Use a base image with the necessary tools
+FROM ubuntu:24.04 as build
+
+RUN apt-get update && apt-get install -y build-essential software-properties-common git git-lfs gettext cmake mtools wget curl which
+
+ARG ARM_TOOLCHAIN_URL=https://developer.arm.com/-/media/Files/downloads/gnu/13.2.rel1/binrel/
+ARG ARM_TOOLCHAIN_FILE=arm-gnu-toolchain-13.2.rel1-x86_64-arm-none-eabi.tar.gz
+ARG DOWNLOAD_DIR=/root/bin
+
+RUN mkdir ${DOWNLOAD_DIR} && cd ${DOWNLOAD_DIR} && curl -LO ${ARM_TOOLCHAIN_URL}/${ARM_TOOLCHAIN_FILE}
+
+RUN cd ${DOWNLOAD_DIR} && pwd && tar -xf ${ARM_TOOLCHAIN_FILE}
+
+ARG ARM_TOOLCHAIN_DIR=arm-gnu-toolchain-13.2.Rel1-x86_64-arm-none-eabi
+
+ENV PATH="${PATH}:${DOWNLOAD_DIR}/${ARM_TOOLCHAIN_DIR}/bin"
+
+RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs -y | sh
+
+RUN apt-get install -y git wget flex bison gperf python3 python3-pip python3-venv cmake ninja-build
+
+RUN apt-get install -y ccache libffi-dev libssl-dev dfu-util libusb-1.0-0 python-is-python3
+
+# RUN mkdir -p /root/adafruit && cd /root/adafruit && git clone https://github.com/adafruit/circuitpython.git
+
+ENV IDF_TOOLS_PATH=/root/.espressif
+ENV IDF_PATH=/root/esp/esp-idf
+
+RUN mkdir -p /root/esp && cd /root/esp && git clone -b v5.2.2 --recursive https://github.com/espressif/esp-idf.git && ls
+
+RUN cd /root/esp/esp-idf && ./install.sh all
+
+RUN curl -LO https://raw.githubusercontent.com/adafruit/circuitpython/main/requirements-dev.txt
+
+RUN curl -LO https://raw.githubusercontent.com/adafruit/circuitpython/main/requirements-doc.txt
+
+RUN . /root/esp/esp-idf/export.sh && pip3 install --upgrade -r requirements-dev.txt && \
+           pip3 install --upgrade -r requirements-doc.txt
+
+# RUN . /root/esp/esp-idf/export.sh && pip3 install --upgrade -r /root/adafruit/circuitpython/requirements-dev.txt && \
+#           pip3 install --upgrade -r /root/adafruit/circuitpython/requirements-doc.txt
+
+# RUN cd /root/adafruit/circuitpython && make fetch-all-submodules
+
+# RUN cd /root/adafruit/circuitpython/ports/espressif && . /root/esp/esp-idf/export.sh && make BOARD=espressif_esp32s3_devkitc_1_n8
+
+# RUN rm -rf /root/adafruit
+
+COPY build.sh /root
+
+RUN chmod +x /root/build.sh
+
+ENTRYPOINT ["/bin/bash"]
+
+# sudo chown -R "${USER:-$(id -un)}" .
+
diff --git a/tools/docker-build/README.md b/tools/docker-build/README.md
new file mode 100644
index 000000000000..f31c61cdd1f3
--- /dev/null
+++ b/tools/docker-build/README.md
@@ -0,0 +1,25 @@
+# Building CircuitPython with Docker
+
+On a Linux machine with `docker` installed, an executable for any supported CircuitPython board can be built without setup by invoking the command `tools/docker-build/build <port> <board-name> <option>` from the CircuitPython root directory.  For example, if the CircuitPython repo is located at `~/circuitpython` the commands
+
+```bash
+    cd ~/circuitpython
+    sudo tools/docker-build/build espressif adafruit_feather_esp32s2_reverse_tft
+    sudo tools/docker-build/build raspberrypi waveshare_rp2040_zero
+    sudo tools/docker-build/build atmel-samd grandcentral_m4_express DEBUG=1
+```
+
+will build executables for a Feather ESP32S2 board and a Waveshare RP2040 board, and build an executable which includes debugging information for an Adafruit Grand Cental M4 Express board.
+
+## Building a new Docker image
+
+The `build` script uses tools built into a container image pulled from a public Docker Hub repository.  If you like, you can build your own image from the `Dockerfile` in this directory with the command
+
+```bash
+    docker build -t <name> .
+```
+
+Where <name> is the name that will be applied to the image.  If you then change the value of `$LOCAL_IMAGE` in the `build` script to match <name>, `build` will use the new image for building CircuitPython.
+
+ 
+
diff --git a/tools/docker-build/build b/tools/docker-build/build
new file mode 100755
index 000000000000..bfc9085b5411
--- /dev/null
+++ b/tools/docker-build/build
@@ -0,0 +1,9 @@
+#!/bin/bash
+REMOTE_IMAGE="timchinowsky/build_circuitpython"
+LOCAL_IMAGE="timchinowsky/build_circuitpython"
+
+make fetch-all-submodules
+docker pull $REMOTE_IMAGE
+docker run -it -v .:/root/circuitpython $LOCAL_IMAGE /root/build.sh $1 $2 $3
+chown -R `(stat -c '%u' Makefile)`:`(stat -c '%g' Makefile)` *
+chown -R `(stat -c '%u' Makefile)`:`(stat -c '%g' Makefile)` .git
diff --git a/tools/docker-build/build.sh b/tools/docker-build/build.sh
new file mode 100644
index 000000000000..8b16efa3a297
--- /dev/null
+++ b/tools/docker-build/build.sh
@@ -0,0 +1,18 @@
+#!/bin/bash
+
+DIR=$(pwd)
+
+git config --global --add safe.directory /root/circuitpython
+git config --global --add safe.directory /root/circuitpython/ports/espressif/esp-idf
+
+cd /root/circuitpython
+
+make fetch-tags
+
+. /root/esp/esp-idf/export.sh
+
+cd /root/circuitpython/ports/$1
+
+# cd $DIR
+
+make BOARD=$2 $3

From 539d02ffbe2f5f6755706f361d3aa62f9e74e6ae Mon Sep 17 00:00:00 2001
From: Tim <timchinowsky@gmail.com>
Date: Tue, 18 Jun 2024 10:08:45 -0700
Subject: [PATCH 2/5] fix README

---
 tools/docker-build/README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/tools/docker-build/README.md b/tools/docker-build/README.md
index f31c61cdd1f3..b98fa340d903 100644
--- a/tools/docker-build/README.md
+++ b/tools/docker-build/README.md
@@ -1,6 +1,6 @@
 # Building CircuitPython with Docker
 
-On a Linux machine with `docker` installed, an executable for any supported CircuitPython board can be built without setup by invoking the command `tools/docker-build/build <port> <board-name> <option>` from the CircuitPython root directory.  For example, if the CircuitPython repo is located at `~/circuitpython` the commands
+On a Linux machine with `docker` installed, an executable for any supported CircuitPython board can be built without setup by invoking the command `sudo tools/docker-build/build <port> <board-name> <option>` from the CircuitPython root directory.  For example, if the CircuitPython repo is located at `~/circuitpython` the commands
 
 ```bash
     cd ~/circuitpython

From d9bef70cb8da344f224acb2ae6a864013b13ecf4 Mon Sep 17 00:00:00 2001
From: Tim <timchinowsky@gmail.com>
Date: Tue, 18 Jun 2024 10:25:19 -0700
Subject: [PATCH 3/5] update README

---
 tools/docker-build/README.md | 5 +----
 1 file changed, 1 insertion(+), 4 deletions(-)

diff --git a/tools/docker-build/README.md b/tools/docker-build/README.md
index b98fa340d903..0851413f5cf0 100644
--- a/tools/docker-build/README.md
+++ b/tools/docker-build/README.md
@@ -9,7 +9,7 @@ On a Linux machine with `docker` installed, an executable for any supported Circ
     sudo tools/docker-build/build atmel-samd grandcentral_m4_express DEBUG=1
 ```
 
-will build executables for a Feather ESP32S2 board and a Waveshare RP2040 board, and build an executable which includes debugging information for an Adafruit Grand Cental M4 Express board.
+will build executables for a Feather ESP32S2 board, a Waveshare RP2040 board and an Adafruit Grand Central M4 Express board, and the Grand Central build will include debugging information.
 
 ## Building a new Docker image
 
@@ -20,6 +20,3 @@ The `build` script uses tools built into a container image pulled from a public
 ```
 
 Where <name> is the name that will be applied to the image.  If you then change the value of `$LOCAL_IMAGE` in the `build` script to match <name>, `build` will use the new image for building CircuitPython.
-
- 
-

From 2ce8449609cd4d83f1d07cf8198fa46fb256eded Mon Sep 17 00:00:00 2001
From: Tim <timchinowsky@gmail.com>
Date: Tue, 18 Jun 2024 10:32:39 -0700
Subject: [PATCH 4/5] Clean up Dockerfile

---
 tools/docker-build/Dockerfile | 15 ---------------
 1 file changed, 15 deletions(-)

diff --git a/tools/docker-build/Dockerfile b/tools/docker-build/Dockerfile
index 466a35972b71..5b395c9f5012 100644
--- a/tools/docker-build/Dockerfile
+++ b/tools/docker-build/Dockerfile
@@ -1,4 +1,3 @@
-# Use a base image with the necessary tools
 FROM ubuntu:24.04 as build
 
 RUN apt-get update && apt-get install -y build-essential software-properties-common git git-lfs gettext cmake mtools wget curl which
@@ -21,8 +20,6 @@ RUN apt-get install -y git wget flex bison gperf python3 python3-pip python3-ven
 
 RUN apt-get install -y ccache libffi-dev libssl-dev dfu-util libusb-1.0-0 python-is-python3
 
-# RUN mkdir -p /root/adafruit && cd /root/adafruit && git clone https://github.com/adafruit/circuitpython.git
-
 ENV IDF_TOOLS_PATH=/root/.espressif
 ENV IDF_PATH=/root/esp/esp-idf
 
@@ -37,20 +34,8 @@ RUN curl -LO https://raw.githubusercontent.com/adafruit/circuitpython/main/requi
 RUN . /root/esp/esp-idf/export.sh && pip3 install --upgrade -r requirements-dev.txt && \
            pip3 install --upgrade -r requirements-doc.txt
 
-# RUN . /root/esp/esp-idf/export.sh && pip3 install --upgrade -r /root/adafruit/circuitpython/requirements-dev.txt && \
-#           pip3 install --upgrade -r /root/adafruit/circuitpython/requirements-doc.txt
-
-# RUN cd /root/adafruit/circuitpython && make fetch-all-submodules
-
-# RUN cd /root/adafruit/circuitpython/ports/espressif && . /root/esp/esp-idf/export.sh && make BOARD=espressif_esp32s3_devkitc_1_n8
-
-# RUN rm -rf /root/adafruit
-
 COPY build.sh /root
 
 RUN chmod +x /root/build.sh
 
 ENTRYPOINT ["/bin/bash"]
-
-# sudo chown -R "${USER:-$(id -un)}" .
-

From 965707e86717e08672a29dc0cbfc136657012f59 Mon Sep 17 00:00:00 2001
From: Tim <timchinowsky@gmail.com>
Date: Thu, 20 Jun 2024 13:24:28 -0700
Subject: [PATCH 5/5] fix permissions

---
 tools/docker-build/Dockerfile | 31 ++++++++++++++++++-------------
 tools/docker-build/README.md  | 10 +++++-----
 tools/docker-build/build      | 10 ++++++----
 tools/docker-build/build.sh   | 15 ++++++---------
 4 files changed, 35 insertions(+), 31 deletions(-)

diff --git a/tools/docker-build/Dockerfile b/tools/docker-build/Dockerfile
index 5b395c9f5012..c4f1dd76c073 100644
--- a/tools/docker-build/Dockerfile
+++ b/tools/docker-build/Dockerfile
@@ -1,16 +1,20 @@
 FROM ubuntu:24.04 as build
 
-RUN apt-get update && apt-get install -y build-essential software-properties-common git git-lfs gettext cmake mtools wget curl which
-
 ARG ARM_TOOLCHAIN_URL=https://developer.arm.com/-/media/Files/downloads/gnu/13.2.rel1/binrel/
+
 ARG ARM_TOOLCHAIN_FILE=arm-gnu-toolchain-13.2.rel1-x86_64-arm-none-eabi.tar.gz
-ARG DOWNLOAD_DIR=/root/bin
 
-RUN mkdir ${DOWNLOAD_DIR} && cd ${DOWNLOAD_DIR} && curl -LO ${ARM_TOOLCHAIN_URL}/${ARM_TOOLCHAIN_FILE}
+ARG ARM_TOOLCHAIN_DIR=arm-gnu-toolchain-13.2.Rel1-x86_64-arm-none-eabi
 
-RUN cd ${DOWNLOAD_DIR} && pwd && tar -xf ${ARM_TOOLCHAIN_FILE}
+ARG TOOLS_DIR=/tools
 
-ARG ARM_TOOLCHAIN_DIR=arm-gnu-toolchain-13.2.Rel1-x86_64-arm-none-eabi
+ARG DOWNLOAD_DIR=${TOOLS_DIR}/bin
+
+RUN apt-get update && apt-get install -y build-essential software-properties-common git git-lfs gettext cmake mtools wget curl which
+
+RUN mkdir -p ${DOWNLOAD_DIR} && cd ${DOWNLOAD_DIR} && curl -LO ${ARM_TOOLCHAIN_URL}/${ARM_TOOLCHAIN_FILE}
+
+RUN cd ${DOWNLOAD_DIR} && pwd && tar -xf ${ARM_TOOLCHAIN_FILE} && rm ${ARM_TOOLCHAIN_FILE}
 
 ENV PATH="${PATH}:${DOWNLOAD_DIR}/${ARM_TOOLCHAIN_DIR}/bin"
 
@@ -20,22 +24,23 @@ RUN apt-get install -y git wget flex bison gperf python3 python3-pip python3-ven
 
 RUN apt-get install -y ccache libffi-dev libssl-dev dfu-util libusb-1.0-0 python-is-python3
 
-ENV IDF_TOOLS_PATH=/root/.espressif
-ENV IDF_PATH=/root/esp/esp-idf
+ENV IDF_TOOLS_PATH=${TOOLS_DIR}/.espressif
+
+ENV IDF_PATH=${TOOLS_DIR}/esp/esp-idf
 
-RUN mkdir -p /root/esp && cd /root/esp && git clone -b v5.2.2 --recursive https://github.com/espressif/esp-idf.git && ls
+RUN mkdir -p ${TOOLS_DIR}/esp && cd ${TOOLS_DIR}/esp && git clone -b v5.2.2 --recursive https://github.com/espressif/esp-idf.git
 
-RUN cd /root/esp/esp-idf && ./install.sh all
+RUN cd ${TOOLS_DIR}/esp/esp-idf && ./install.sh all
 
 RUN curl -LO https://raw.githubusercontent.com/adafruit/circuitpython/main/requirements-dev.txt
 
 RUN curl -LO https://raw.githubusercontent.com/adafruit/circuitpython/main/requirements-doc.txt
 
-RUN . /root/esp/esp-idf/export.sh && pip3 install --upgrade -r requirements-dev.txt && \
+RUN . ${TOOLS_DIR}/esp/esp-idf/export.sh && pip3 install --upgrade -r requirements-dev.txt && \
            pip3 install --upgrade -r requirements-doc.txt
 
-COPY build.sh /root
+COPY build.sh ${TOOLS_DIR}
 
-RUN chmod +x /root/build.sh
+RUN chmod -R a=u ${TOOLS_DIR}
 
 ENTRYPOINT ["/bin/bash"]
diff --git a/tools/docker-build/README.md b/tools/docker-build/README.md
index 0851413f5cf0..2400d8823c29 100644
--- a/tools/docker-build/README.md
+++ b/tools/docker-build/README.md
@@ -1,15 +1,15 @@
 # Building CircuitPython with Docker
 
-On a Linux machine with `docker` installed, an executable for any supported CircuitPython board can be built without setup by invoking the command `sudo tools/docker-build/build <port> <board-name> <option>` from the CircuitPython root directory.  For example, if the CircuitPython repo is located at `~/circuitpython` the commands
+On a Linux machine with `docker` installed, an executable for any supported CircuitPython board can be built without setup by invoking the command `tools/docker-build/build <port> <board-name> <option>` from the CircuitPython root directory.  For example, if the CircuitPython repo is located at `~/circuitpython` the commands
 
 ```bash
     cd ~/circuitpython
-    sudo tools/docker-build/build espressif adafruit_feather_esp32s2_reverse_tft
-    sudo tools/docker-build/build raspberrypi waveshare_rp2040_zero
-    sudo tools/docker-build/build atmel-samd grandcentral_m4_express DEBUG=1
+    tools/docker-build/build espressif adafruit_feather_esp32s2_reverse_tft
+    tools/docker-build/build raspberrypi waveshare_rp2040_zero
+    tools/docker-build/build atmel-samd grandcentral_m4_express DEBUG=1 TRANSLATION=es
 ```
 
-will build executables for a Feather ESP32S2 board, a Waveshare RP2040 board and an Adafruit Grand Central M4 Express board, and the Grand Central build will include debugging information.
+will build executables for a Feather ESP32S2 board, a Waveshare RP2040 board and an Adafruit Grand Central M4 Express board, and the Grand Central build will include debugging information and Spanish localization.
 
 ## Building a new Docker image
 
diff --git a/tools/docker-build/build b/tools/docker-build/build
index bfc9085b5411..1ab82d240485 100755
--- a/tools/docker-build/build
+++ b/tools/docker-build/build
@@ -1,9 +1,11 @@
 #!/bin/bash
+
 REMOTE_IMAGE="timchinowsky/build_circuitpython"
-LOCAL_IMAGE="timchinowsky/build_circuitpython"
+
+LOCAL_IMAGE=$REMOTE_IMAGE
 
 make fetch-all-submodules
+
 docker pull $REMOTE_IMAGE
-docker run -it -v .:/root/circuitpython $LOCAL_IMAGE /root/build.sh $1 $2 $3
-chown -R `(stat -c '%u' Makefile)`:`(stat -c '%g' Makefile)` *
-chown -R `(stat -c '%u' Makefile)`:`(stat -c '%g' Makefile)` .git
+
+docker run --user $UID:$(id -g) -it -v .:/circuitpython $LOCAL_IMAGE /tools/build.sh "$@"
diff --git a/tools/docker-build/build.sh b/tools/docker-build/build.sh
index 8b16efa3a297..bbeb8abac0f3 100644
--- a/tools/docker-build/build.sh
+++ b/tools/docker-build/build.sh
@@ -1,18 +1,15 @@
 #!/bin/bash
 
-DIR=$(pwd)
+git config --global --add safe.directory /circuitpython
 
-git config --global --add safe.directory /root/circuitpython
-git config --global --add safe.directory /root/circuitpython/ports/espressif/esp-idf
+git config --global --add safe.directory /circuitpython/ports/espressif/esp-idf
 
-cd /root/circuitpython
+cd /circuitpython
 
 make fetch-tags
 
-. /root/esp/esp-idf/export.sh
+. /tools/esp/esp-idf/export.sh
 
-cd /root/circuitpython/ports/$1
+cd /circuitpython/ports/$1
 
-# cd $DIR
-
-make BOARD=$2 $3
+make BOARD=${@:2}