You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/en/lib_builder.rst
+4-4
Original file line number
Diff line number
Diff line change
@@ -184,8 +184,8 @@ Specify additional configs to be applied. ex. 'qio 80m' to compile for QIO Flash
184
184
Docker Image
185
185
------------
186
186
187
-
You can use a docker image that for building the static libraries of ESP-IDF components for use in Arduino projects.
188
-
This image contains a copy of the ``esp32-arduino-lib-builder`` repository and already include or will obtain all the required tools and dependencies to build the Arduino static libraries.
187
+
You can use a docker image for building the static libraries of ESP-IDF components for use in Arduino projects.
188
+
This image contains a copy of the ``esp32-arduino-lib-builder`` repository and already includes or will obtain all the required tools and dependencies to build the Arduino static libraries.
189
189
190
190
The current supported architectures by the Docker image are:
191
191
@@ -242,13 +242,13 @@ This will start the Lib Builder UI for compiling the libraries. The above comman
242
242
Otherwise, the folder will be created with root permissions and files generated inside the container might cause permission issues and compilation errors.
243
243
244
244
.. note::
245
-
When the mounted directory, ``/arduino-esp32``, contains a git repository owned by a different user (``UID``) than the one running the Docker container,
245
+
When the mounted directory ``/arduino-esp32`` contains a git repository owned by a different user (``UID``) than the one running the Docker container,
246
246
git commands executed within ``/arduino-esp32`` might fail, displaying an error message ``fatal: detected dubious ownership in repository at '/arduino-esp32'``.
247
247
To resolve this issue, you can designate the ``/arduino-esp32`` directory as safe by setting the ``LIBBUILDER_GIT_SAFE_DIR`` environment variable during the Docker container startup.
248
248
For instance, you can achieve this by including ``-e LIBBUILDER_GIT_SAFE_DIR='/arduino-esp32'`` as a parameter. Additionally, multiple directories can be specified by using a ``:`` separator.
249
249
To entirely disable this git security check, ``*`` can be used.
250
250
251
-
After running the above command, you will be inside the container and can build the libraries using the user interface.
251
+
After running the above command, you will be inside the container and the libraries can be built using the user interface.
252
252
253
253
By default the docker container will run the user interface script. If you want to run a specific command, you can pass it as an argument to the ``docker run`` command.
254
254
For example, to run a terminal inside the container, you can run:
0 commit comments