doc: fix typo in multiple directories before v3.7.0 release
Utilize a code spell-checking tool to scan for and correct spelling errors in various files within the `doc` directory. Signed-off-by: Pisit Sawangvonganan <pisit@ndrsolution.com>
This commit is contained in:
parent
33c87c8e8b
commit
eead5104fc
11 changed files with 24 additions and 24 deletions
4
doc/build/kconfig/tips.rst
vendored
4
doc/build/kconfig/tips.rst
vendored
|
@ -315,8 +315,8 @@ In summary, here are some recommended practices for ``select``:
|
||||||
- Select simple helper symbols without prompts and dependencies however much
|
- Select simple helper symbols without prompts and dependencies however much
|
||||||
you like. They're a great tool for simplifying Kconfig files.
|
you like. They're a great tool for simplifying Kconfig files.
|
||||||
|
|
||||||
- An exemption are busses like I2C and SPI, and following the same thought
|
- An exemption are buses like I2C and SPI, and following the same thought
|
||||||
process things like MFD as well. Drivers on these busses should use
|
process things like MFD as well. Drivers on these buses should use
|
||||||
``select`` to allow the automatic activation of the necessary bus drivers
|
``select`` to allow the automatic activation of the necessary bus drivers
|
||||||
when devices on the bus are enabled in the devicetree.
|
when devices on the bus are enabled in the devicetree.
|
||||||
|
|
||||||
|
|
|
@ -884,10 +884,10 @@ MTU requirements
|
||||||
The Basic Audio Profile (BAP) has a requirement that both sides shall support a minimum ATT_MTU of
|
The Basic Audio Profile (BAP) has a requirement that both sides shall support a minimum ATT_MTU of
|
||||||
at least 64 on the unenhanced ATT bearer or at least one enhanced ATT bearer.
|
at least 64 on the unenhanced ATT bearer or at least one enhanced ATT bearer.
|
||||||
The requirement comes from the preferred (or sometimes mandatory) use of GATT Write Without
|
The requirement comes from the preferred (or sometimes mandatory) use of GATT Write Without
|
||||||
Response, and where support for Write Long Characterstic Value is optional in most cases.
|
Response, and where support for Write Long Characteristic Value is optional in most cases.
|
||||||
|
|
||||||
If a ASCS device supports values larger than the minimum ATT_MTU of 64 octets, then it shall supoort
|
If a ASCS device supports values larger than the minimum ATT_MTU of 64 octets, then it shall support
|
||||||
Read long Characterstic Value by setting :kconfig:option:`CONFIG_BT_ATT_PREPARE_COUNT` to a
|
Read long Characteristic Value by setting :kconfig:option:`CONFIG_BT_ATT_PREPARE_COUNT` to a
|
||||||
non-zero value.
|
non-zero value.
|
||||||
|
|
||||||
LE Audio resources
|
LE Audio resources
|
||||||
|
@ -923,7 +923,7 @@ The project is mostly automated,
|
||||||
and the LE Audio contributors almost only rely on the automated workflows
|
and the LE Audio contributors almost only rely on the automated workflows
|
||||||
to present the state of development.
|
to present the state of development.
|
||||||
Anyone is able to pick any of the open issues and work on it.
|
Anyone is able to pick any of the open issues and work on it.
|
||||||
If you cannot assign the issue to youself,
|
If you cannot assign the issue to yourself,
|
||||||
please leave a comment in the issue itself or ping the Discord channel for help.
|
please leave a comment in the issue itself or ping the Discord channel for help.
|
||||||
|
|
||||||
Bluetooth SIG errata for LE Audio
|
Bluetooth SIG errata for LE Audio
|
||||||
|
|
|
@ -309,7 +309,7 @@ characteristics representing remote endpoints.
|
||||||
Supported max codec frames per SDU: 1
|
Supported max codec frames per SDU: 1
|
||||||
Codec capabilities metadata:
|
Codec capabilities metadata:
|
||||||
Preferred audio contexts:
|
Preferred audio contexts:
|
||||||
Converstation (0x0002)
|
Conversational (0x0002)
|
||||||
Media (0x0004)
|
Media (0x0004)
|
||||||
ep 0x81754e0
|
ep 0x81754e0
|
||||||
ep 0x81755d4
|
ep 0x81755d4
|
||||||
|
|
|
@ -504,7 +504,7 @@ Enabling and configuring
|
||||||
|
|
||||||
Enable data cache by selecting :kconfig:option:`CONFIG_LWM2M_RESOURCE_DATA_CACHE_SUPPORT`.
|
Enable data cache by selecting :kconfig:option:`CONFIG_LWM2M_RESOURCE_DATA_CACHE_SUPPORT`.
|
||||||
Application needs to allocate an array of :c:struct:`lwm2m_time_series_elem` structures and then
|
Application needs to allocate an array of :c:struct:`lwm2m_time_series_elem` structures and then
|
||||||
enable the cache by calling :c:func:`lwm2m_engine_enable_cache` for a given resource. Earch resource
|
enable the cache by calling :c:func:`lwm2m_engine_enable_cache` for a given resource. Each resource
|
||||||
must be enabled separately and each resource needs their own storage.
|
must be enabled separately and each resource needs their own storage.
|
||||||
|
|
||||||
.. code-block:: c
|
.. code-block:: c
|
||||||
|
|
|
@ -24,7 +24,7 @@ Zephyr's implementation of PTP stack consist following items:
|
||||||
* Integration with ptp_clock driver
|
* Integration with ptp_clock driver
|
||||||
* PTP stack initialization executed during system init
|
* PTP stack initialization executed during system init
|
||||||
|
|
||||||
The implementation automatically creates PTP Ports (each PTP Port coresponds to unique interface).
|
The implementation automatically creates PTP Ports (each PTP Port corresponds to unique interface).
|
||||||
|
|
||||||
Supported features
|
Supported features
|
||||||
******************
|
******************
|
||||||
|
@ -61,7 +61,7 @@ Based on Table 59 from section 15.5.2.3 of the IEEE 1588-2019 following manageme
|
||||||
are supported:
|
are supported:
|
||||||
|
|
||||||
.. csv-table:: Supported management message's IDs
|
.. csv-table:: Supported management message's IDs
|
||||||
:header: Management_ID, Management_ID name, Allowed acctions
|
:header: Management_ID, Management_ID name, Allowed actions
|
||||||
:widths: 10,40,25
|
:widths: 10,40,25
|
||||||
|
|
||||||
0x0000, NULL_PTP_MANAGEMENT, GET SET COMMAND
|
0x0000, NULL_PTP_MANAGEMENT, GET SET COMMAND
|
||||||
|
|
|
@ -452,7 +452,7 @@ Interface number and endpoint address assignment
|
||||||
|
|
||||||
In USB terminology, a ``function`` is a device that provides a capability to the
|
In USB terminology, a ``function`` is a device that provides a capability to the
|
||||||
host, such as a HID class device that implements a keyboard. A function
|
host, such as a HID class device that implements a keyboard. A function
|
||||||
constains a collection of ``interfaces``; at least one interface is required. An
|
contains a collection of ``interfaces``; at least one interface is required. An
|
||||||
interface may contain device ``endpoints``; for example, at least one input
|
interface may contain device ``endpoints``; for example, at least one input
|
||||||
endpoint is required to implement a HID class device, and no endpoints are
|
endpoint is required to implement a HID class device, and no endpoints are
|
||||||
required to implement a USB DFU class. A USB device that combines functions is
|
required to implement a USB DFU class. A USB device that combines functions is
|
||||||
|
@ -474,7 +474,7 @@ Also, one controller may be able to have IN/OUT endpoints on the same endpoint
|
||||||
number, interrupt IN endpoint 0x81 and bulk OUT endpoint 0x01, while the other
|
number, interrupt IN endpoint 0x81 and bulk OUT endpoint 0x01, while the other
|
||||||
may only be able to handle one endpoint per endpoint number. Information about
|
may only be able to handle one endpoint per endpoint number. Information about
|
||||||
the number of interfaces, interface associations, endpoint types, and addresses
|
the number of interfaces, interface associations, endpoint types, and addresses
|
||||||
is provided to the host by the interface, interface specifiec, and endpoint
|
is provided to the host by the interface, interface specific, and endpoint
|
||||||
descriptors.
|
descriptors.
|
||||||
|
|
||||||
Host driver for specific function, uses interface and endpoint descriptor to
|
Host driver for specific function, uses interface and endpoint descriptor to
|
||||||
|
|
|
@ -296,7 +296,7 @@ As with all OpenSDA debug probes, the steps for programming the firmware are:
|
||||||
|
|
||||||
#. After you power on the board, release the reset button. A USB mass storage
|
#. After you power on the board, release the reset button. A USB mass storage
|
||||||
device called **BOOTLOADER** or **MAINTENANCE** will enumerate. If the
|
device called **BOOTLOADER** or **MAINTENANCE** will enumerate. If the
|
||||||
enumerated device is named **BOOTLOADER**, please first update the booloader
|
enumerated device is named **BOOTLOADER**, please first update the bootloader
|
||||||
to the latest revision by following the instructions for a
|
to the latest revision by following the instructions for a
|
||||||
`DAPLink Bootloader Update`_.
|
`DAPLink Bootloader Update`_.
|
||||||
|
|
||||||
|
@ -334,7 +334,7 @@ As with all OpenSDA debug probes, the steps for programming the firmware are:
|
||||||
|
|
||||||
#. After you power on the board, release the reset button. A USB mass storage
|
#. After you power on the board, release the reset button. A USB mass storage
|
||||||
device called **BOOTLOADER** or **MAINTENANCE** will enumerate. If the
|
device called **BOOTLOADER** or **MAINTENANCE** will enumerate. If the
|
||||||
enumerated device is named **BOOTLOADER**, please first update the booloader
|
enumerated device is named **BOOTLOADER**, please first update the bootloader
|
||||||
to the latest revision by following the instructions for a
|
to the latest revision by following the instructions for a
|
||||||
`DAPLink Bootloader Update`_.
|
`DAPLink Bootloader Update`_.
|
||||||
|
|
||||||
|
|
|
@ -757,7 +757,7 @@ done by passing a command to Renode, using an argument provided by the runner:
|
||||||
west simulate --runner=renode --renode-command start
|
west simulate --runner=renode --renode-command start
|
||||||
|
|
||||||
To pass an argument to Renode itself, for example to start Renode in console mode
|
To pass an argument to Renode itself, for example to start Renode in console mode
|
||||||
intead of a separate window:
|
instead of a separate window:
|
||||||
|
|
||||||
west simulate --runner=renode --renode-arg="--console"
|
west simulate --runner=renode --renode-arg="--console"
|
||||||
|
|
||||||
|
|
|
@ -458,7 +458,7 @@ details laid out here apply to all architectures except x86, which are
|
||||||
covered in the `x86 Details`_ section below.
|
covered in the `x86 Details`_ section below.
|
||||||
|
|
||||||
The invocation of :c:macro:`IRQ_CONNECT` will declare an instance of
|
The invocation of :c:macro:`IRQ_CONNECT` will declare an instance of
|
||||||
struct _isr_list wich is placed in a special .intList section.
|
struct _isr_list which is placed in a special .intList section.
|
||||||
This section is placed in compiled code on precompilation stages only.
|
This section is placed in compiled code on precompilation stages only.
|
||||||
It is meant to be used by Zephyr script to generate interrupt tables
|
It is meant to be used by Zephyr script to generate interrupt tables
|
||||||
and is removed from the final build.
|
and is removed from the final build.
|
||||||
|
@ -467,7 +467,7 @@ and produce the required output.
|
||||||
|
|
||||||
The default parser generates C arrays filled with arguments and interrupt
|
The default parser generates C arrays filled with arguments and interrupt
|
||||||
handlers in a form of addresses directly taken from .intList section entries.
|
handlers in a form of addresses directly taken from .intList section entries.
|
||||||
It works with all the architectures and compillers (with the exception mentioned above).
|
It works with all the architectures and compilers (with the exception mentioned above).
|
||||||
The limitation of this parser is the fact that after the arrays are generated
|
The limitation of this parser is the fact that after the arrays are generated
|
||||||
it is expected for the code not to relocate.
|
it is expected for the code not to relocate.
|
||||||
Any relocation on this stage may lead to the situation where the entry in the interrupt array
|
Any relocation on this stage may lead to the situation where the entry in the interrupt array
|
||||||
|
@ -478,7 +478,7 @@ The local isr declaration parser uses different approach to construct
|
||||||
the same arrays at binnary level.
|
the same arrays at binnary level.
|
||||||
All the entries to the arrays are declared and defined locally,
|
All the entries to the arrays are declared and defined locally,
|
||||||
directly in the file where :c:macro:`IRQ_CONNECT` is used.
|
directly in the file where :c:macro:`IRQ_CONNECT` is used.
|
||||||
They are placed in a section with the unique, synthetized name.
|
They are placed in a section with the unique, synthesized name.
|
||||||
The name of the section is then placed in .intList section and it is used to create linker script
|
The name of the section is then placed in .intList section and it is used to create linker script
|
||||||
to properly place the created entry in the right place in the memory.
|
to properly place the created entry in the right place in the memory.
|
||||||
This parser is now limited to the supported architectures and toolchains but in reward it keeps
|
This parser is now limited to the supported architectures and toolchains but in reward it keeps
|
||||||
|
@ -602,7 +602,7 @@ Then automatically generated linker scripts are used to place it in the right pl
|
||||||
This option requires enabling by the choose of :kconfig:option:`ISR_TABLES_LOCAL_DECLARATION`.
|
This option requires enabling by the choose of :kconfig:option:`ISR_TABLES_LOCAL_DECLARATION`.
|
||||||
If this configuration is supported by the used architecture and toolchaing the
|
If this configuration is supported by the used architecture and toolchaing the
|
||||||
:kconfig:option:`ISR_TABLES_LOCAL_DECLARATION_SUPPORTED` is set.
|
:kconfig:option:`ISR_TABLES_LOCAL_DECLARATION_SUPPORTED` is set.
|
||||||
See defails of this option for the information about currently supported configurations.
|
See details of this option for the information about currently supported configurations.
|
||||||
|
|
||||||
Any invocation of :c:macro:`IRQ_CONNECT` or `IRQ_DIRECT_CONNECT` will declare an instance of struct
|
Any invocation of :c:macro:`IRQ_CONNECT` or `IRQ_DIRECT_CONNECT` will declare an instance of struct
|
||||||
_isr_list_sname which is placde in a special .intList section:
|
_isr_list_sname which is placde in a special .intList section:
|
||||||
|
@ -643,7 +643,7 @@ It can be changed to variable that points to a interrupt handler:
|
||||||
|
|
||||||
static uintptr_t <unique name> = ((uintptr_t)func);
|
static uintptr_t <unique name> = ((uintptr_t)func);
|
||||||
|
|
||||||
Or to actuall naked function that implements a jump to the interrupt handler:
|
Or to actually naked function that implements a jump to the interrupt handler:
|
||||||
|
|
||||||
.. code-block:: c
|
.. code-block:: c
|
||||||
|
|
||||||
|
@ -652,7 +652,7 @@ Or to actuall naked function that implements a jump to the interrupt handler:
|
||||||
__asm(ARCH_IRQ_VECTOR_JUMP_CODE(func));
|
__asm(ARCH_IRQ_VECTOR_JUMP_CODE(func));
|
||||||
}
|
}
|
||||||
|
|
||||||
Simillar like for :c:macro:`IRQ_CONNECT`, the created variable or function is placed
|
Similar like for :c:macro:`IRQ_CONNECT`, the created variable or function is placed
|
||||||
in a section, saved in _isr_list_sname section.
|
in a section, saved in _isr_list_sname section.
|
||||||
|
|
||||||
Files generated by the script
|
Files generated by the script
|
||||||
|
|
|
@ -186,7 +186,7 @@ though that is allowed behavior). If the architecture supports directed IPIs
|
||||||
(see :kconfig:option:`CONFIG_ARCH_HAS_DIRECTED_IPIS`), then the
|
(see :kconfig:option:`CONFIG_ARCH_HAS_DIRECTED_IPIS`), then the
|
||||||
architecture also provides a :c:func:`arch_sched_directed_ipi` call, which
|
architecture also provides a :c:func:`arch_sched_directed_ipi` call, which
|
||||||
when invoked will flag an interrupt on the specified CPUs. When an interrupt is
|
when invoked will flag an interrupt on the specified CPUs. When an interrupt is
|
||||||
flagged on the CPUs, the :c:func:`z_sched_ipi` function implmented in the
|
flagged on the CPUs, the :c:func:`z_sched_ipi` function implemented in the
|
||||||
scheduler will get invoked on those CPUs. The expectation is that these
|
scheduler will get invoked on those CPUs. The expectation is that these
|
||||||
APIs will evolve over time to encompass more functionality (e.g. cross-CPU
|
APIs will evolve over time to encompass more functionality (e.g. cross-CPU
|
||||||
calls), and that the scheduler-specific calls here will be implemented in
|
calls), and that the scheduler-specific calls here will be implemented in
|
||||||
|
|
|
@ -332,7 +332,7 @@ Boards & SoC Support
|
||||||
|
|
||||||
* On :ref:`ST STM32H7B3I Discovery Kit <stm32h7b3i_dk_board>`: ``stm32h7b3i_dk_board``,
|
* On :ref:`ST STM32H7B3I Discovery Kit <stm32h7b3i_dk_board>`: ``stm32h7b3i_dk_board``,
|
||||||
enabled full cache management, Chrom-ART, double frame buffer and full refresh for
|
enabled full cache management, Chrom-ART, double frame buffer and full refresh for
|
||||||
optimal LVGL perfomances.
|
optimal LVGL performance.
|
||||||
* On ST STM32 boards, stm32cubeprogrammer runner can now be used to program external
|
* On ST STM32 boards, stm32cubeprogrammer runner can now be used to program external
|
||||||
flash using ``--extload`` option.
|
flash using ``--extload`` option.
|
||||||
|
|
||||||
|
@ -871,7 +871,7 @@ Networking
|
||||||
* Implemented IPv6 Privacy Extensions according to RFC 8981.
|
* Implemented IPv6 Privacy Extensions according to RFC 8981.
|
||||||
* Added :c:func:`net_ipv6_is_private_addr` API function.
|
* Added :c:func:`net_ipv6_is_private_addr` API function.
|
||||||
* Implemented reachability hint for IPv6. Upper layers can use
|
* Implemented reachability hint for IPv6. Upper layers can use
|
||||||
c:func:`net_if_nbr_reachability_hint` to report Neigbor reachability and
|
c:func:`net_if_nbr_reachability_hint` to report Neighbor reachability and
|
||||||
avoid unnecessary Neighbor Discovery solicitations.
|
avoid unnecessary Neighbor Discovery solicitations.
|
||||||
* Added :kconfig:option:`CONFIG_NET_IPV6_MTU` allowing to set custom IPv6 MTU.
|
* Added :kconfig:option:`CONFIG_NET_IPV6_MTU` allowing to set custom IPv6 MTU.
|
||||||
* Added :kconfig:option:`CONFIG_NET_MCAST_ROUTE_MAX_IFACES` which allows to set
|
* Added :kconfig:option:`CONFIG_NET_MCAST_ROUTE_MAX_IFACES` which allows to set
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue