Skip to content

Commit 2a22823

Browse files
kartbenjhedberg
authored andcommitted
doc: releases: cosmetic/typo fixes to 4.3 release notes & migration guide
Fixes a few minor typos / copy-paste errors / indentation / etc. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
1 parent 037af5f commit 2a22823

File tree

2 files changed

+50
-50
lines changed

2 files changed

+50
-50
lines changed

doc/releases/migration-guide-4.3.rst

Lines changed: 42 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Base Libraries
5858
The old Kconfig option still exists, but will be overridden if the custom requirements
5959
are larger. To force the old Kconfig option to be used, even when its value is less
6060
than the indicated custom requirements, a new :kconfig:option:`CONFIG_ZVFS_OPEN_IGNORE_MIN`
61-
option has been introduced (which defaults being disabled).
61+
option has been introduced (which defaults to being disabled).
6262

6363
Boards
6464
******
@@ -83,7 +83,7 @@ Boards
8383
(> v0.12.0) in which the HLA/SWD transport has been deprecated (see
8484
https://review.openocd.org/c/openocd/+/8523 and commit
8585
https://sourceforge.net/p/openocd/code/ci/34ec5536c0ba3315bc5a841244bbf70141ccfbb4/).
86-
Issues may be encountered when connecting to an ST-Link adapter running firmware prior
86+
Issues may be encountered when connecting to an ST-Link adapter running firmware prior to
8787
v2j24 which do not support the new transport. In this case, the ST-Link firmware should
8888
be upgraded or, if not possible, the OpenOCD configuration script should be changed to
8989
source "interface/stlink-hla.cfg" and select the "hla_swd" interface explicitly.
@@ -134,7 +134,7 @@ DMA
134134

135135
* DMA no longer implements user mode syscalls as part of its API. The syscalls were determined to be
136136
too broadly defined in access and impossible to implement the syscall parameter verification step
137-
in another.
137+
in a safe manner.
138138

139139
Ethernet
140140
========
@@ -147,21 +147,21 @@ Ethernet
147147
enabled in the Xilinx GEM Ethernet driver (:dtcompatible:`xlnx,gem`). By default, offloading is
148148
now enabled by default to improve performance, however, offloading is always disabled for QEMU
149149
targets due to the checksum generation in hardware not being emulated regardless of whether it
150-
is explicitly disabled via the devicetree or not. (:github:`95435`)
150+
is explicitly disabled via the Devicetree or not. (:github:`95435`)
151151

152-
* Replaced devicetree property ``rx-checksum-offload`` which enabled RX checksum offloading
153-
``disable-rx-checksum-offload`` which now actively disables it.
154-
* Replaced devicetree property ``tx-checksum-offload`` which enabled TX checksum offloading
155-
``disable-tx-checksum-offload`` which now actively disables it.
152+
* Replaced Devicetree property ``rx-checksum-offload`` which enabled RX checksum offloading
153+
``disable-rx-checksum-offload`` which now actively disables it.
154+
* Replaced Devicetree property ``tx-checksum-offload`` which enabled TX checksum offloading
155+
``disable-tx-checksum-offload`` which now actively disables it.
156156

157157
* The Xilinx GEM Ethernet driver (:dtcompatible:`xlnx,gem`) now obtains the AMBA AHB data bus
158158
width matching the current target SoC (either Zynq-7000 or ZynqMP) from a design configuration
159-
register at run-time, making the devicetree property ``amba-ahb-dbus-width`` obsolete, which
159+
register at run-time, making the Devicetree property ``amba-ahb-dbus-width`` obsolete, which
160160
has therefore been removed.
161161

162162
* The :dtcompatible:`nxp,enet-mac` and :dtcompatible:`xlnx,gem` drivers are no longer configuring
163163
the link speed and duplex mode of the phy via :c:func:`phy_configure_link` during initialization.
164-
Instead, the user has to use the ``default-speeds`` devicetree property of the phy, if they want
164+
Instead, the user has to use the ``default-speeds`` Devicetree property of the phy, if they want
165165
to restrict the advertised speeds for auto-negotiation, when the mac only supports a subset of the
166166
phy supported speeds. (:github:`91572`)
167167

@@ -240,11 +240,11 @@ Bluetooth Controller
240240

241241
* The following have been renamed:
242242

243-
* :kconfig:option:`CONFIG_BT_CTRL_ADV_ADI_IN_SCAN_RSP` to
244-
:kconfig:option:`CONFIG_BT_CTLR_ADV_ADI_IN_SCAN_RSP`
245-
* :c:struct:`bt_hci_vs_fata_error_cpu_data_cortex_m` to
246-
:c:struct:`bt_hci_vs_fatal_error_cpu_data_cortex_m` and now contains the program counter
247-
value.
243+
* :kconfig:option:`CONFIG_BT_CTRL_ADV_ADI_IN_SCAN_RSP` to
244+
:kconfig:option:`CONFIG_BT_CTLR_ADV_ADI_IN_SCAN_RSP`
245+
* :c:struct:`bt_hci_vs_fata_error_cpu_data_cortex_m` to
246+
:c:struct:`bt_hci_vs_fatal_error_cpu_data_cortex_m` and now contains the program counter
247+
value.
248248

249249
.. zephyr-keep-sorted-start re(^\w)
250250
@@ -264,7 +264,7 @@ Bluetooth Audio
264264
* The BAP Scan Delegator will no longer automatically update the PA sync state, and
265265
:c:func:`bt_bap_scan_delegator_set_pa_state` must be used to update the state. If the
266266
BAP Scan Delegator is used together with the BAP Broadcast Sink, then the PA state of the
267-
receive state of a :c:struct:`bt_bap_broadcast_sink` will still be automatically updated when the
267+
receive state of a :c:struct:`bt_bap_broadcast_sink` will still be automatically updated when the
268268
PA state changes. (:github:`95453`)
269269

270270

@@ -273,7 +273,7 @@ Bluetooth Audio
273273
Bluetooth HCI
274274
=============
275275

276-
* The deprecated ``ipm`` value was removed from ``bt-hci-bus`` devicetree property.
276+
* The deprecated ``ipm`` value was removed from ``bt-hci-bus`` Devicetree property.
277277
``ipc`` should be used instead.
278278

279279
Bluetooth Mesh
@@ -296,13 +296,13 @@ Power management
296296
****************
297297

298298
* :kconfig:option:`CONFIG_PM_S2RAM` and :kconfig:option:`PM_S2RAM_CUSTOM_MARKING` have been
299-
refactored to be automatically managed by SoCs and the devicetree. Applications shall no
299+
refactored to be automatically managed by SoCs and the Devicetree. Applications shall no
300300
longer enable them directly, instead, enable or disable the "suspend-to-ram" power states
301-
in the devicetree.
301+
in the Devicetree.
302302

303-
* For the NXP RW61x, the devicetree property ``exit-latency-us`` has been updated to reflect more
303+
* For the NXP RW61x, the Devicetree property ``exit-latency-us`` has been updated to reflect more
304304
accurate, measured wake-up times. For applications utilizing Standby mode (PM3), this update and
305-
an increase to the ``min-residency-us`` devicetree property may influence how the system
305+
an increase to the ``min-residency-us`` Devicetree property may influence how the system
306306
transitions between power modes. In some cases, this could lead to changes in power consumption.
307307

308308
Networking
@@ -361,7 +361,7 @@ PTP Clock
361361
*********
362362

363363
* The doc of :c:func:`ptp_clock_rate_adjust` API didn't provide proper and clear function description.
364-
Drivers implemented it to adjust rate ratio relatively based on current frequency.
364+
Drivers implemented it to adjust rate ratio relative to the current frequency.
365365
Now PI servo is introduced in both PTP and gPTP, and this API function is changed to use for rate
366366
ratio adjusting based on nominal frequency. Drivers implementing :c:func:`ptp_clock_rate_adjust`
367367
should be adjusted to account for the new behavior.
@@ -458,7 +458,7 @@ Shell
458458
=====
459459

460460
* The MQTT topics related to :kconfig:option:`SHELL_BACKEND_MQTT` have been renamed. Renamed
461-
``<device_id>_rx`` to ``<device_id>/sh/rx`` and ``<device_id>_tx`` to ``<device_id>/sh/rx``. The
461+
``<device_id>_rx`` to ``<device_id>/sh/rx`` and ``<device_id>_tx`` to ``<device_id>/sh/tx``. The
462462
part after the ``<device_id>`` is now configurable via :kconfig:option:`SHELL_MQTT_TOPIC_RX_ID`
463463
and :kconfig:option:`SHELL_MQTT_TOPIC_TX_ID`. This allows keeping the previous topics for backward
464464
compatibility.
@@ -483,7 +483,7 @@ MCUboot
483483
=======
484484

485485
* The default operating mode for MCUboot has been changed to swap using offset, this provides
486-
faster swap updates needed less overhead and reduces the flash endurance cycles required to
486+
faster swap updates, needs less overhead, and reduces the flash endurance cycles required to
487487
perform an update, the previous default was swap using move. If a board was optimised for swap
488488
using move by having a primary slot that was one sector larger than the secondary then this
489489
needs to change to have the secondary slot one sector larger than the primary (for optimised
@@ -496,14 +496,14 @@ Silabs
496496

497497
* Aligned the name of the Rail options with the other SiSDK related options:
498498

499-
* :kconfig:option:`CONFIG_RAIL_PA_CURVE_HEADER` to
500-
:kconfig:option:`CONFIG_SILABS_SISDK_RAIL_PA_CURVE_HEADER`
501-
* :kconfig:option:`CONFIG_RAIL_PA_CURVE_TYPES_HEADER` to
502-
:kconfig:option:`CONFIG_SILABS_SISDK_RAIL_PA_CURVE_TYPES_HEADER`
503-
* :kconfig:option:`CONFIG_RAIL_PA_ENABLE_CALIBRATION` to
504-
:kconfig:option:`CONFIG_SILABS_SISDK_RAIL_PA_ENABLE_CALIBRATION`
499+
* :kconfig:option:`CONFIG_RAIL_PA_CURVE_HEADER` to
500+
:kconfig:option:`CONFIG_SILABS_SISDK_RAIL_PA_CURVE_HEADER`
501+
* :kconfig:option:`CONFIG_RAIL_PA_CURVE_TYPES_HEADER` to
502+
:kconfig:option:`CONFIG_SILABS_SISDK_RAIL_PA_CURVE_TYPES_HEADER`
503+
* :kconfig:option:`CONFIG_RAIL_PA_ENABLE_CALIBRATION` to
504+
:kconfig:option:`CONFIG_SILABS_SISDK_RAIL_PA_ENABLE_CALIBRATION`
505505

506-
* Fixed name of the :kconfig:option:`CONFIG_SOC_*`. These option contained PART_NUMBER in their
506+
* Fixed name of the :kconfig:option:`CONFIG_SOC_*`. These options contained PART_NUMBER in their
507507
while they shouldn't.
508508

509509
* The separate ``em3`` power state was removed from Series 2 SoCs. The system automatically
@@ -530,19 +530,19 @@ Trusted Firmware-M
530530
TF-M NS and require BL2 must have their flash layout with the flash controller
531531
information. This will ensure that when signing the hex/bin files all the
532532
details will be present in the S and NS images. The image now has the details
533-
to allow the FWU state machine be correct and allow FOTA.
533+
to allow the FWU state machine to be correct and allow FOTA.
534534
(:github:`94470`)
535535

536-
* The ``--align`` parameter was fixed to 1. Now, it's set to the flash DT ``write_block_size``
537-
property, but still provides 1 as a fallback for specific vendors.
538-
* The ``--max-sectors`` value is now calculated based on the number of images, taking into
539-
consideration the largest image size.
540-
* The ``--confirm`` option now confirms both S and NS HEX images, ensuring that any image
541-
that runs is valid for production and development.
542-
* S and NS BIN images are now available. These are the correct images to be used in FOTA. Note
543-
that S and NS images are unconfirmed by default, and the application is responsible for
544-
confirming them with ``psa_fwu_accept()``. Otherwise, the images will roll back on the next
545-
reboot.
536+
* The ``--align`` parameter was fixed to 1. Now, it's set to the flash DT ``write_block_size``
537+
property, but still provides 1 as a fallback for specific vendors.
538+
* The ``--max-sectors`` value is now calculated based on the number of images, taking into
539+
consideration the largest image size.
540+
* The ``--confirm`` option now confirms both S and NS HEX images, ensuring that any image
541+
that runs is valid for production and development.
542+
* S and NS BIN images are now available. These are the correct images to be used in FOTA. Note
543+
that S and NS images are unconfirmed by default, and the application is responsible for
544+
confirming them with ``psa_fwu_accept()``. Otherwise, the images will roll back on the next
545+
reboot.
546546

547547
* A compatibility issue was identified in the TF-M attestation procedure introduced
548548
after the TF-M v2.1.0 release. As a result, systems using TF-M v2.1 cannot be

doc/releases/release-notes-4.3.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,13 @@ Major enhancements with this release include:
4242
**CPU load and dynamic frequency scaling subsystems**
4343
A new experimental :ref:`CPU frequency <cpu_freq>` scaling subsystem enables dynamic,
4444
policy-driven, clock adjustments to balance power consumption and performance.
45-
Alongside it, a new :ref:`cpu_load` subsystem allows to obtain CPU usage metrics based on
45+
Alongside it, a new :ref:`cpu_load` subsystem allows users to obtain CPU usage metrics based on
4646
scheduler statistics, which can be used to drive the frequency scaling policy.
4747

4848
**Instrumentation Subsystem**
4949
A new :ref:`instrumentation subsystem <instrumentation>` simplifies tracing and profiling of
50-
Zephyr applications by leveraging compiler-managed function instrumentation, allowing to record
51-
call-graph traces and statistical profiles at runtime.
50+
Zephyr applications by leveraging compiler-managed function instrumentation, allowing the
51+
recording of call-graph traces and statistical profiles at runtime.
5252

5353
**OCPP 1.6 library**
5454
A new :ref:`OCPP (Open Charge Point Protocol) <ocpp_interface>` library enables EV charging
@@ -115,9 +115,9 @@ Removed APIs and options
115115
* The legacy pipe object API was removed. Use the new pipe API instead.
116116
* ``bt_le_set_auto_conn``
117117
* ``CONFIG_BT_BUF_ACL_RX_COUNT``
118-
* ``ok`` enum value has now been removed completely from ``base.yaml`` binding ``status`` property in devicetree.
119-
* STM32 LPTIM clock source selection through Kconfig was removed. Device Tree must now be used instead.
120-
Affected Kconfig symbols: ``CONFIG_STM32_LPTIM_CLOCK_LSI`` / ``CONFIG_STM32_LPTIM_CLOCK_LSI``
118+
* ``ok`` enum value has now been removed completely from ``base.yaml`` binding ``status`` property in Devicetree.
119+
* STM32 LPTIM clock source selection through Kconfig was removed. Devicetree must now be used instead.
120+
Affected Kconfig symbols: :kconfig:option:`CONFIG_STM32_LPTIM_CLOCK_LSI` / :kconfig:option:`CONFIG_STM32_LPTIM_CLOCK_LSE`
121121

122122
Deprecated APIs and options
123123
===========================
@@ -437,7 +437,7 @@ New APIs and options
437437
* Wi-Fi
438438

439439
* :kconfig:option:`CONFIG_WIFI_NM_WPA_SUPPLICANT_DEBUG_SHOW_KEYS`
440-
* Set enterprise crypto insecure because certifcate validation is disabled.
440+
* Set enterprise crypto insecure because certificate validation is disabled.
441441
* If the usage mode option has AP enabled, then automatically enable AP mode.
442442
* Add configuration options for background scanning (bgscan) in wpa_supplicant.
443443
* Add support for multiple virtual interfaces (VIF).
@@ -458,7 +458,7 @@ New APIs and options
458458
* :c:func:`pm_device_driver_deinit`
459459
* :kconfig:option:`CONFIG_PM_DEVICE_RUNTIME_DEFAULT_ENABLE`
460460
* :kconfig:option:`CONFIG_PM_S2RAM` has been refactored to be promptless. The application now
461-
only needs to enable any "suspend-to-ram" power state in the devicetree.
461+
only needs to enable any "suspend-to-ram" power state in the Devicetree.
462462
* The :kconfig:option:`PM_S2RAM_CUSTOM_MARKING` has been renamed to
463463
:kconfig:option:`HAS_PM_S2RAM_CUSTOM_MARKING` and refactored to be promptless. This option
464464
is now selected by SoCs if they need it for their "suspend-to-ram" implementations.

0 commit comments

Comments
 (0)