Skip to content

Commit 3760548

Browse files
fabiobaltierimmahadevan108
authored andcommitted
doc: release: various cleanups for 3.2
Various manual cleanups for the 3.2 release notes: spelling, wrong bindings, tags... Signed-off-by: Fabio Baltieri <[email protected]>
1 parent a8590d8 commit 3760548

File tree

1 file changed

+34
-35
lines changed

1 file changed

+34
-35
lines changed

doc/releases/release-notes-3.2.rst

Lines changed: 34 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -242,8 +242,8 @@ Architectures
242242
* Enabled automatic placement of the IRQ vector table.
243243
* Enabled S2RAM for Cortex-M, hooking up the provided API functions.
244244
* Added icache and dcache maintenance functions, and switched to the new
245-
Kconfig symbols (:kconfig:option:`CPU_HAS_DCACHE` and
246-
:kconfig:option:`CPU_HAS_ICACHE`).
245+
Kconfig symbols (:kconfig:option:`CONFIG_CPU_HAS_DCACHE` and
246+
:kconfig:option:`CONFIG_CPU_HAS_ICACHE`).
247247
* Added data/instr. sync barriers after writing to ``SCTLR`` to disable MPU.
248248
* Use ``spsr_cxsf`` instead of unpredictable ``spsr_hyp`` on Cortex-R52.
249249
* Removes ``-Wstringop-overread`` warning with GCC 12.
@@ -271,7 +271,7 @@ Architectures
271271
* Introduced support for RV32E.
272272
* Reduced callee-saved registers for RV32E.
273273
* Introduced Zicsr, Zifencei and BitManip as separate extensions.
274-
* Introduced :kconfig:option:`CONFIG_ALWAYS_SWITCH_THROUGH_ECALL` for
274+
* Introduced :kconfig:option:`CONFIG_RISCV_ALWAYS_SWITCH_THROUGH_ECALL` for
275275
plaforms that require every ``mret`` to be balanced by ``ecall``.
276276
* IRQ vector table is now used for vectored mode.
277277
* Disabled :kconfig:option:`CONFIG_IRQ_VECTOR_TABLE_JUMP_BY_CODE` for CLIC.
@@ -293,7 +293,7 @@ Architectures
293293

294294
* Macros ``RSR`` and ``WSR`` have been renamed to :c:macro:`XTENSA_RSR`
295295
and :c:macro:`XTENSA_WSR` to give them proper namespace.
296-
* Fixed a rounding error in timing function when coverting from cycles
296+
* Fixed a rounding error in timing function when converting from cycles
297297
to nanoseconds.
298298
* Fixed the calculation of average "cycles to nanoseconds" to actually
299299
return nanoseconds instead of cycles.
@@ -351,7 +351,7 @@ Bluetooth
351351
* The handling of GATT multiple notifications has been rewritten, and is now
352352
only to be used as a low-level API
353353
* Added support for GATT CCCs in arbitrary locations as a client
354-
* Extended the ``bt_conn_info`` structure with security information
354+
* Extended the :c:struct:`bt_conn_info` structure with security information
355355
* Added a new :kconfig:option:`CONFIG_BT_PRIVACY_RANDOMIZE_IR` that prevents
356356
the Host from using Controller-provided identity roots
357357
* Added support for GATT over EATT
@@ -387,7 +387,7 @@ Bluetooth
387387
* Added a new :kconfig:option:`CONFIG_BT_CTLR_SYNC_PERIODIC_SKIP_ON_SCAN_AUX`
388388
for allowing periodic sync event skipping
389389
* Added a new :kconfig:option:`CONFIG_BT_CTLR_SCAN_AUX_SYNC_RESERVE_MIN` for
390-
minimal time resevation
390+
minimal time reservation
391391
* Implemented ISO Test Mode HCI commands
392392
* Added support for multiple BIS sync selection within a BIG
393393
* Implement flushing pending ISO TX PDUs when a BIG event is terminated
@@ -623,7 +623,6 @@ Drivers and Sensors
623623
* Added Flash support for Cadence QSPI NOR FLASH.
624624
* Fixed usage fault on nRF driver (along with BLE) due to possible incorrect handling of the ticker stop operation.
625625

626-
627626
* GPIO
628627

629628
* Added GPIO driver for Renesas Smartbond platform
@@ -675,7 +674,7 @@ Drivers and Sensors
675674

676675
* KSCAN
677676

678-
* Enable the touch panel on the NXP MIMXRT1170 EVK.
677+
* Enabled the touch panel on the NXP MIMXRT1170 EVK.
679678

680679
* LED
681680

@@ -840,7 +839,7 @@ Networking
840839
* LwM2M:
841840

842841
* Moved LwM2M 1.1 support out of experimental.
843-
* Refactored SenML-JSON and JSON econder/decoder to use Zephyr's JSON library
842+
* Refactored SenML-JSON and JSON encoder/decoder to use Zephyr's JSON library
844843
internally.
845844
* Extended LwM2M shell module with the following commands: ``exec``, ``read``,
846845
``write``, ``start``, ``stop``, ``update``, ``pause``, ``resume``.
@@ -1079,10 +1078,9 @@ Devicetree
10791078
* :dtcompatible:`arm,armv8m-itm`
10801079
* :dtcompatible:`arm,armv8m-systick`
10811080
* :dtcompatible:`arm,beetle-syscon`
1082-
* :dtcompatible:`arm,itm`
10831081
* :dtcompatible:`arm,pl022`
10841082
* :dtcompatible:`aspeed,ast10x0-clock`
1085-
* :dtcompatible:`atmel,24mac402`
1083+
* :dtcompatible:`atmel,at24mac402`
10861084
* :dtcompatible:`atmel,ataes132a`
10871085
* :dtcompatible:`atmel,sam-smc`
10881086
* :dtcompatible:`atmel,sam4l-flashcalw-controller`
@@ -1097,7 +1095,7 @@ Devicetree
10971095
* :dtcompatible:`espressif,esp32-twai`
10981096
* :dtcompatible:`espressif,esp32-usb-serial`
10991097
* :dtcompatible:`espressif,esp32-wifi`
1100-
* :dtcompatible:`gd,gd32-adac`
1098+
* :dtcompatible:`gd,gd32-adc`
11011099
* :dtcompatible:`gd,gd32-cctl`
11021100
* :dtcompatible:`gd,gd32-dma`
11031101
* :dtcompatible:`gd,gd32-flash-controller`
@@ -1160,9 +1158,9 @@ Devicetree
11601158
* :dtcompatible:`renesas,smartbond-pinctrl`
11611159
* :dtcompatible:`renesas,smartbond-uart`
11621160
* :dtcompatible:`sifive,clint0`
1163-
* :dtcompatible:`sifive,e24.yaml` (formerly ``riscv,sifive-e24``)
1164-
* :dtcompatible:`sifive,e31.yaml` (formerly ``riscv,sifive-e31``)
1165-
* :dtcompatible:`sifive,e51.yaml` (formerly ``riscv,sifive-e51``)
1161+
* :dtcompatible:`sifive,e24` (formerly ``riscv,sifive-e24``)
1162+
* :dtcompatible:`sifive,e31` (formerly ``riscv,sifive-e31``)
1163+
* :dtcompatible:`sifive,e51` (formerly ``riscv,sifive-e51``)
11661164
* :dtcompatible:`sifive,s7` (formerly ``riscv,sifive-s7``)
11671165
* :dtcompatible:`silabs,gecko-semailbox`
11681166
* :dtcompatible:`snps,arc-iot-sysconf`
@@ -1258,7 +1256,7 @@ Devicetree
12581256

12591257
* :dtcompatible:`intel,adsp-tlb`:
12601258
new ``paddr-size``, ``exec-bit-idx``, ``write-bit-idx`` properties
1261-
* :dtcompatible:`intel,cavs-shim-clkctl`: new ``wovcro-supported`` property
1259+
* :dtcompatible:`intel,adsp-shim-clkctl`: new ``wovcro-supported`` property
12621260
* Removed ``intel,dmic`` binding
12631261
* Removed ``intel,s1000-pinmux`` binding
12641262

@@ -1349,7 +1347,7 @@ Devicetree
13491347
``border-waveform`` properties are now optional.
13501348
* ``riscv,clint0`` removed; all in-tree users were converted to
13511349
``sifive,clint0`` or derived bindings
1352-
* :dtcompatible:`worldsemi,ws2812`: SPI bindings have new ``spi-cpol``,
1350+
* :dtcompatible:`worldsemi,ws2812-spi`: SPI bindings have new ``spi-cpol``,
13531351
``spi-cpha`` properties
13541352
* :dtcompatible:`ns16550`: ``reg-shift`` is now required
13551353
* Removed ``reserved-memory`` binding
@@ -1485,7 +1483,8 @@ Libraries / Subsystems
14851483

14861484
* Introduced a 'zephyr,buffer-size' DT property to set the sizes for TX and
14871485
RX buffers per created instance.
1488-
* Set WQ priority back to PRIO_PREEMPT to fix an issue that was starving the scheduler.
1486+
* Set WQ priority back to ``PRIO_PREEMPT`` to fix an issue that was starving
1487+
the scheduler.
14891488
* ``icmsg_buf`` library was renamed to ``spsc_pbuf``.
14901489
* Added cache handling support to ``spsc_pbuf``.
14911490
* Fixed an issue where the TX virtqueue was misaligned by 2 bytes due to the
@@ -1512,19 +1511,19 @@ Libraries / Subsystems
15121511

15131512
* POSIX
15141513

1515-
* Make ``tz`` non-const in ``gettimeofday()`` for conformance to spec.
1516-
* Fix pthread descriptor resource leak. Previously only pthreads with state
1514+
* Made ``tz`` non-const in ``gettimeofday()`` for conformance to spec.
1515+
* Fixed pthread descriptor resource leak. Previously only pthreads with state
15171516
``PTHREAD_TERMINATED`` could be reused. However, ``pthread_join()`` sets
15181517
the state to ``PTHREAD_EXITED``. Consider both states as candidates in
15191518
``pthread_create()``.
1520-
* Add ``perror()`` implementation
1521-
* Use consistent timebase in ``sem_timedwait()``
1519+
* Added ``perror()`` implementation
1520+
* Used consistent timebase in ``sem_timedwait()``
15221521

15231522
* RTIO
15241523

15251524
* Initial version of an asynchronous task and executor API for I/O similar inspired
15261525
by Linux's very successful io_uring.
1527-
* Provides a simple linear and limited concurrency executor, simple task queuing,
1526+
* Provided a simple linear and limited concurrency executor, simple task queuing,
15281527
and the ability to poll for task completions.
15291528

15301529
* SD Subsystem
@@ -1558,14 +1557,14 @@ Libraries / Subsystems
15581557
* Testsuite
15591558

15601559
* Added Kconfig support to ``unit_testing`` platform.
1561-
* Migrate tests to use :kconfig:option:`CONFIG_ZTEST_NEW_API`
1562-
* Add ztest options for shuffling tests/suites via:
1560+
* Migrated tests to use :kconfig:option:`CONFIG_ZTEST_NEW_API`
1561+
* Added ztest options for shuffling tests/suites via:
15631562

15641563
* :kconfig:option:`CONFIG_ZTEST_SHUFFLE`
15651564
* :kconfig:option:`CONFIG_ZTEST_SHUFFLE_SUITE_REPEAT_COUNT`
15661565
* :kconfig:option:`CONFIG_ZTEST_SHUFFLE_TEST_REPEAT_COUNT`
15671566

1568-
* Add ztest native_posix command line arguments for running specific tests/suites using
1567+
* Added ztest native_posix command line arguments for running specific tests/suites using
15691568
``--test suite_name:*`` or ``--test suite_name::test_name`` command line arguments.
15701569

15711570
* Tracing
@@ -1581,7 +1580,7 @@ HALs
15811580

15821581
* Atmel
15831582

1584-
* sam: Fix incorrect CIDR values for revision b silicon of SAMV71 devices.
1583+
* sam: Fixed incorrect CIDR values for revision b silicon of SAMV71 devices.
15851584

15861585
* Espressif
15871586

@@ -1671,7 +1670,7 @@ MCUboot
16711670
Trusted Firmware-M
16721671
******************
16731672

1674-
* Allow enabling FPU in the application when TF-M is enabled.
1673+
* Allowed enabling FPU in the application when TF-M is enabled.
16751674
* Added option to exclude non-secure TF-M application from build.
16761675
* Relocated ``mergehex.py`` to ``scripts/build``.
16771676
* Added option for custom reset handlers.
@@ -1887,7 +1886,7 @@ Addressed issues
18871886
* :github:`50394` - RT685 flash chip size is incorrect
18881887
* :github:`50386` - Twister "FLASH overflow" does not account for imgtool trailer.
18891888
* :github:`50374` - CI failure in v3.1.0-rc2 full run
1890-
* :github:`50368` - esp32: counter driver not working with absoulte value
1889+
* :github:`50368` - esp32: counter driver not working with absolute value
18911890
* :github:`50344` - bl5340_dvk_cpuapp: undefined reference to ``__device_dts_ord_14``
18921891
* :github:`50343` - uninitialized variable in kernel.workqueue test
18931892
* :github:`50342` - mcuboot: BOOT_MAX_ALIGN is redefined
@@ -1951,7 +1950,7 @@ Addressed issues
19511950
* :github:`49982` - SD: f_sync will always fail using the sdhc_spi driver
19521951
* :github:`49970` - strange behavior in the spi_flash example
19531952
* :github:`49960` - LoRaWAN Code won't linking when config with CN470 region
1954-
* :github:`49956` - ``NRF_DRIVE_S0D1`` option is not always overriden in the ``nordic,nrf-twi`` and ``nordic,nrf-twim`` nodes
1953+
* :github:`49956` - ``NRF_DRIVE_S0D1`` option is not always overridden in the ``nordic,nrf-twi`` and ``nordic,nrf-twim`` nodes
19551954
* :github:`49953` - stm32 gpio_basic_api test fail with CONFIG_ZTEST_NEW_API
19561955
* :github:`49939` - stm32 adc driver_api test fails on stm32wb55 and stm32l5
19571956
* :github:`49938` - drivers/modem/gsm_ppp.c: unnecessary modem_cmd_handler_tx_lock when CONFIG_GSM_MUX disabled
@@ -2123,7 +2122,7 @@ Addressed issues
21232122
* :github:`48808` - Pinctl api breaks NXP imx6sx
21242123
* :github:`48806` - Bluetooth: controller: conformance test instability
21252124
* :github:`48804` - LE Audio: Add HAP sample to Zephyr footprint tracking
2126-
* :github:`48801` - test: driver: wdt: wdt cases fails in LPC platfrom randonly
2125+
* :github:`48801` - test: driver: wdt: wdt cases fails in LPC platform randonly
21272126
* :github:`48799` - Why is the command input incomplete?
21282127
* :github:`48780` - boards: bus devices label names should include address on bus
21292128
* :github:`48779` - net.socket.select: failed (qemu/mps2_an385)
@@ -2428,7 +2427,7 @@ Addressed issues
24282427
* :github:`46345` - get_maintainer.py incorrectly invoked by Github?
24292428
* :github:`46341` - Zephyr scheduler lock: add selective locking up to a given priority ceiling
24302429
* :github:`46335` - For ESP32, initialization of static object during declaration with derived class type doesn't work.
2431-
* :github:`46326` - Async UART for STM32 U5 suppport
2430+
* :github:`46326` - Async UART for STM32 U5 support
24322431
* :github:`46325` - ESP32 strcmp error while enable MCUBOOT and NEWLIB_LIBC
24332432
* :github:`46324` - it8xxx2_evb: tests/kernel/sched/schedule_api fail due to k_sleep(K_MSEC(100)) not correct
24342433
* :github:`46322` - Time units in shtcx sensor
@@ -2485,7 +2484,7 @@ Addressed issues
24852484
* :github:`45827` - bluetooth: bluetooth host: Adding the same device to resolving list
24862485
* :github:`45807` - CivetWeb doesn't build for CC3232SF
24872486
* :github:`45802` - Some tests reported as PASSED (device) but they were only build
2488-
* :github:`45774` - drivers: gpio: pca9555: Driver is writting to output port despite all pins been configured as input
2487+
* :github:`45774` - drivers: gpio: pca9555: Driver is writing to output port despite all pins been configured as input
24892488
* :github:`45760` - Running twister on new board files
24902489
* :github:`45741` - LE Audio: Allow unique ``bt_codec_qos`` for each unicast stream
24912490
* :github:`45678` - Lorawan: Devnonce has already been used
@@ -2596,7 +2595,7 @@ Addressed issues
25962595
* :github:`42208` - tests/subsys/logging/log_api/ fails qemu_leon3 if ptr_in_rodata() is enabled for SPARC
25972596
* :github:`42197` - Bluetooth: Controller: llcp: No disconnect if remote does not response for initiated control procedure
25982597
* :github:`42134` - TLS handshake error using DTLS on updatehub
2599-
* :github:`42102` - doc: searches for sys_reboot() are inconsistant
2598+
* :github:`42102` - doc: searches for sys_reboot() are inconsistent
26002599
* :github:`41954` - Bluetooth: Controller: BIS: Event timing calculations
26012600
* :github:`41922` - Bluetooth: Controller: ISOAL: TX: Implement SDU Fragmentation into Unframed PDUs
26022601
* :github:`41880` - Strict test ordering in new ztest API
@@ -2700,7 +2699,7 @@ Addressed issues
27002699
* :github:`23032` - Need help to enable Sub-GHz for ieee802154_cc13xx_cc26xx
27012700
* :github:`22208` - gpio: clean up debounce configuration
27022701
* :github:`22079` - Add reception channel information to advertise_report
2703-
* :github:`21980` - Doesnt Install on Raspberry Pi
2702+
* :github:`21980` - Doesn't Install on Raspberry Pi
27042703
* :github:`21234` - drivers: usb_dc_sam0: usb detach and reattach does not work
27052704
* :github:`19979` - Implement Cortex-R floating-point support
27062705
* :github:`19244` - BLE throughput of DFU by Mcumgr is too slow

0 commit comments

Comments
 (0)