docs: fix duplicate word typos across docs and hal

Removes duplicated "the" typos in FreeRTOS, eFuse, Kconfig documentation, and the HAL README.

Signed-off-by: Atharva-2708 <atharva.btech27@gmail.com>
This commit is contained in:
Atharva-2708
2026-07-19 15:31:16 +05:30
parent 055ba9d3f9
commit f8544b40df
4 changed files with 4 additions and 4 deletions
+1 -1
View File
@@ -8,7 +8,7 @@ In a broad sense, the HAL layer consists of two sub-layers: HAL (upper) and Low-
## Low-Level (`hal/<periph>_ll.h`) ## Low-Level (`hal/<periph>_ll.h`)
Functions defined in the file must be static inlined. The first argument of an LL function is usually a pointer to the peripheral's base address [^1]. At the moment, each ESP target has its own set of Low-Level drivers. They're located under path e.g. `components/hal/<target>/include/hal/<periph>_ll.h`. We wish the the low-level functions could be as independent as possible, so that the caller doesn't need to worry about conflict between different sub-modules. For example, when resetting the driver of module A, the module B is also reset by accident. However, the digital design is not perfect, coupling happens from time to time. Functions defined in the file must be static inlined. The first argument of an LL function is usually a pointer to the peripheral's base address [^1]. At the moment, each ESP target has its own set of Low-Level drivers. They're located under path e.g. `components/hal/<target>/include/hal/<periph>_ll.h`. We wish the low-level functions could be as independent as possible, so that the caller doesn't need to worry about conflict between different sub-modules. For example, when resetting the driver of module A, the module B is also reset by accident. However, the digital design is not perfect, coupling happens from time to time.
### Handling Shared Registers ### Handling Shared Registers
@@ -93,7 +93,7 @@ Detailed explanation of the backward compatibility mechanism:
If the user has set any value for the old config option (e.g. old config name is used in ``sdkconfig`` or ``sdkconfig.defaults``) without ``sdkconfig.rename`` file provided, this value would be **silently ignored**. This behavior is the default of the Kconfig system and is not a bug. In the original project (configuration of the linux kernel) this behavior was desired and is still desired in many projects. If the user has set any value for the old config option (e.g. old config name is used in ``sdkconfig`` or ``sdkconfig.defaults``) without ``sdkconfig.rename`` file provided, this value would be **silently ignored**. This behavior is the default of the Kconfig system and is not a bug. In the original project (configuration of the linux kernel) this behavior was desired and is still desired in many projects.
This behavior is suppressed in ESP-IDF by the the configuration tool (invoked by ``idf.py menuconfig``). This tool generates compatibility statements for all the renamed options in the ``sdkconfig`` file. In more detail, the following approach is used to prevent the above mentioned situation: This behavior is suppressed in ESP-IDF by the configuration tool (invoked by ``idf.py menuconfig``). This tool generates compatibility statements for all the renamed options in the ``sdkconfig`` file. In more detail, the following approach is used to prevent the above mentioned situation:
1. Configuration tool searches the whole ESP-IDF folder for ``sdkconfig.rename`` files. If the project target (``<chip>``) matches the last suffix of any ``sdkconfig.rename.<chip>`` file, the file will be used in the next step as well. 1. Configuration tool searches the whole ESP-IDF folder for ``sdkconfig.rename`` files. If the project target (``<chip>``) matches the last suffix of any ``sdkconfig.rename.<chip>`` file, the file will be used in the next step as well.
+1 -1
View File
@@ -400,7 +400,7 @@ How to Add a New Field
The number of bits not included in square brackets are free (some bits are reserved by Espressif). All fields are checked for overlapping bits. The number of bits not included in square brackets are free (some bits are reserved by Espressif). All fields are checked for overlapping bits.
To add child fields to an existing field, :ref:`structured-efuse-fields` can be used. The following example demonstrates adding of the the fields ``SERIAL_NUMBER``, ``MODEL_NUMBER`` and ``HARDWARE_REV`` to an existing ``USER_DATA`` field by using the ``.`` operator: To add child fields to an existing field, :ref:`structured-efuse-fields` can be used. The following example demonstrates adding of the fields ``SERIAL_NUMBER``, ``MODEL_NUMBER`` and ``HARDWARE_REV`` to an existing ``USER_DATA`` field by using the ``.`` operator:
.. code-block:: none .. code-block:: none
+1 -1
View File
@@ -83,7 +83,7 @@ Unlike Vanilla FreeRTOS, users of FreeRTOS in ESP-IDF **must never call** :cpp:f
Background Tasks Background Tasks
^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^
During startup, ESP-IDF and the FreeRTOS kernel automatically create multiple tasks that run in the background (listed in the the table below). During startup, ESP-IDF and the FreeRTOS kernel automatically create multiple tasks that run in the background (listed in the table below).
.. list-table:: List of Tasks Created During Startup .. list-table:: List of Tasks Created During Startup
:widths: 10 75 5 5 5 :widths: 10 75 5 5 5