Skip to content

Commit f273ad6

Browse files
Apply suggestions from code review
Co-authored-by: Jan Procházka <[email protected]>
1 parent 5a27b56 commit f273ad6

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/en/lib_builder.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -184,8 +184,8 @@ Specify additional configs to be applied. ex. 'qio 80m' to compile for QIO Flash
184184
Docker Image
185185
------------
186186

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.
189189

190190
The current supported architectures by the Docker image are:
191191

@@ -242,13 +242,13 @@ This will start the Lib Builder UI for compiling the libraries. The above comman
242242
Otherwise, the folder will be created with root permissions and files generated inside the container might cause permission issues and compilation errors.
243243

244244
.. 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,
246246
git commands executed within ``/arduino-esp32`` might fail, displaying an error message ``fatal: detected dubious ownership in repository at '/arduino-esp32'``.
247247
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.
248248
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.
249249
To entirely disable this git security check, ``*`` can be used.
250250

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.
252252

253253
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.
254254
For example, to run a terminal inside the container, you can run:

0 commit comments

Comments
 (0)