Skip to content

Commit 0eba6ef

Browse files
committed
doc: release: Clean up 2.4.0 release notes
Cleans up grammar, punctuation, and white space in the 2.4.0 release notes. Signed-off-by: Maureen Helm <[email protected]>
1 parent 0ae8d8f commit 0eba6ef

File tree

1 file changed

+54
-67
lines changed

1 file changed

+54
-67
lines changed

doc/releases/release-notes-2.4.rst

Lines changed: 54 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,6 @@ The following CVEs are addressed by this release:
3939
* CVE-2020-13601: Under embargo until 2020/11/18
4040
* CVE-2020-13602: Remote Denial of Service in LwM2M do_write_op_tlv
4141

42-
4342
More detailed information can be found in:
4443
https://docs.zephyrproject.org/latest/security/vulnerabilities.html
4544

@@ -50,7 +49,6 @@ You can check all currently known issues by listing them using the GitHub
5049
interface and listing all issues with the `bug label
5150
<https://github.com/zephyrproject-rtos/zephyr/issues?q=is%3Aissue+is%3Aopen+label%3Abug>`_.
5251

53-
5452
API Changes
5553
***********
5654

@@ -161,11 +159,11 @@ Stable API changes in this release
161159
* HID class callbacks now takes a parameter ``const struct device*`` which
162160
is the HID device for which callback was called.
163161

164-
* Bluetooth:
162+
* Bluetooth
165163

166164
* The ``_gatt_`` infix has been removed from all GATT service APIs.
167165

168-
* Bluetooth HCI Driver:
166+
* Bluetooth HCI Driver
169167

170168
* bt_hci_evt_is_prio() removed, use bt_hci_evt_get_flags() instead when
171169
CONFIG_BT_RECV_IS_RX_THREAD is defined and call bt_recv and bt_recv_prio
@@ -220,7 +218,7 @@ Kernel
220218
Architectures
221219
*************
222220

223-
* ARC:
221+
* ARC
224222

225223
* Added ARC MetaWare toolchain support
226224
* General arch improvements for stacks & memory domains
@@ -229,8 +227,7 @@ Architectures
229227
* Fix for fast irq (one register bank configuration)
230228
* Fix for undefined shift behavior (CID 211523)
231229

232-
233-
* ARM:
230+
* ARM
234231

235232
* AARCH32
236233

@@ -255,13 +252,11 @@ Architectures
255252

256253
* Re-implemented thread context-switch to use the _arch_switch() API
257254

258-
* POSIX:
259-
260-
261-
* RISC-V:
255+
* POSIX
262256

257+
* RISC-V
263258

264-
* x86:
259+
* x86
265260

266261
* x86 MMU paging support has been overhauled to meet CONFIG_MMU requirements.
267262

@@ -289,21 +284,20 @@ Boards & SoC Support
289284

290285
* Made these changes in other SoC series:
291286

292-
* STM32L4/STM32WB: Added support for Low Power Mode
287+
* STM32L4/STM32WB: Added support for Low Power Mode.
293288
* STM32H7/STM32WB/STM32MP1: Added Dual Core concurrent register access
294-
protection using HSEM
295-
* Increase cpu frequency for ARC nsim_hs_smp
296-
289+
protection using HSEM.
290+
* Increased cpu frequency for ARC nsim_hs_smp.
297291

298292
* Changes for ARC boards:
299293

300294
* ARC QEMU boards for ARC EM and HS
301295
* ARC MetaWare toolchain support, including mdb runner for various ARC boards
302296
* gcov coverage support for ARC QEMU
303297
* New nSIM configuration, corresponding to em7d_v22 EMSK board
304-
* Enable SMP on HSDK board, including dual core and quad core configurations
305-
* Switch from legacy ARC-nSIM UART to ns16550 UART model and driver
306-
* Fix EMSDP secure config for emsdp_em7d_esp
298+
* Enabled SMP on HSDK board, including dual core and quad core configurations.
299+
* Switched from legacy ARC-nSIM UART to ns16550 UART model and driver.
300+
* Fixed EMSDP secure config for emsdp_em7d_esp.
307301

308302
* Added support for these ARM boards:
309303

@@ -384,7 +378,7 @@ Drivers and Sensors
384378

385379
* Counter
386380

387-
* STM32: Added support on F0/F2 series
381+
* STM32: Added support on F0/F2 series.
388382
* Added MCUX PIT counter driver for Kinetis K6x and K8x SoCs.
389383

390384
* Crypto
@@ -393,15 +387,15 @@ Drivers and Sensors
393387

394388
* DAC
395389

396-
* STM32: Added support for F0/F2/G4/L1 series
390+
* STM32: Added support for F0/F2/G4/L1 series.
397391

398392
* Debug
399393

400394
* N/A
401395

402396
* Display
403397

404-
* Enhanced SSD16XX driver to support loading WS from OTP
398+
* Enhanced SSD16XX driver to support loading WS from OTP.
405399
* Added chip select flags to SPI display drivers.
406400

407401
* DMA
@@ -418,7 +412,7 @@ Drivers and Sensors
418412

419413
* Entropy
420414

421-
* STM32: Added support for ISR mode. Added support on F7/H7/L0 series
415+
* STM32: Added support for ISR mode. Added support on F7/H7/L0 series.
422416

423417
* ESPI
424418

@@ -429,8 +423,8 @@ Drivers and Sensors
429423
* Ethernet
430424

431425
* Added VLAN support to Intel e1000 driver.
432-
* Added Ethernet support to stm32h7 based boards (with IT based TX)
433-
* Moved stm32 driver to device tree configuration
426+
* Added Ethernet support to stm32h7 based boards (with IT based TX).
427+
* Moved stm32 driver to device tree configuration.
434428
* Added support for setting fixed configuration and read from device tree
435429
for ENET ETH interface and PHY in mcux driver.
436430
* Added support for device that do not use SMI for PHY setup in mcux driver.
@@ -452,11 +446,12 @@ Drivers and Sensors
452446

453447
* GPIO
454448

455-
* Added driver for the Xilinx AXI GPIO IP
449+
* Added driver for the Xilinx AXI GPIO IP.
456450
* Added LPC11U6X driver.
457451

458452
* Hardware Info
459-
* Added Atmel SAM4L driver
453+
454+
* Added Atmel SAM4L driver.
460455

461456
* I2C
462457

@@ -469,8 +464,8 @@ Drivers and Sensors
469464
to be synthesized to test driver behavior. See
470465
:option:`CONFIG_I2C_EMUL`.
471466

472-
* STM32: V1: Reset i2c device on read/write error
473-
* STM32: V2: Added dts configurable Timing option
467+
* STM32: V1: Reset i2c device on read/write error.
468+
* STM32: V2: Added dts configurable Timing option.
474469
* Fixed MCUX LPI2C driver transfer status after NACK.
475470

476471
* I2S
@@ -500,7 +495,7 @@ Drivers and Sensors
500495

501496
* LED
502497

503-
* Added TI LP503X controller driver
498+
* Added TI LP503X controller driver.
504499
* Introduced led_set_color, let_get_info, and channel-dedicated syscalls
505500
* Added shell support.
506501

@@ -532,7 +527,7 @@ Drivers and Sensors
532527

533528
* PWM
534529

535-
* STM32: Refactored using Cube LL API
530+
* STM32: Refactored using Cube LL API.
536531
* Added SAM9 TCC based driver.
537532

538533
* Sensor
@@ -551,9 +546,9 @@ Drivers and Sensors
551546

552547
* Serial
553548

554-
* Added driver for the Xilinx UART Lite IP
549+
* Added driver for the Xilinx UART Lite IP.
555550
* Added NXP IUART driver for i.MX8M Mini.
556-
* Implemented uart_config_get API in MCUX UART driver
551+
* Implemented uart_config_get API in MCUX UART driver.
557552
* Added LPC11U6X driver.
558553

559554
* SPI
@@ -564,7 +559,7 @@ Drivers and Sensors
564559
specify 0 for this field will probably need to be updated to specify
565560
GPIO_ACTIVE_LOW. SPI_CS_ACTIVE_LOW/HIGH are still used for chip
566561
selects that are not specified by a cs-gpios property.
567-
* Added driver for the Xilinx AXI Quad SPI IP
562+
* Added driver for the Xilinx AXI Quad SPI IP.
568563
* STM32: Various fixes around DMA mode.
569564
* Extended MCUX Flexcomm driver to support slave mode.
570565
* Added optional delays to MCUX DSPI and LPSPI drivers.
@@ -607,7 +602,7 @@ Drivers and Sensors
607602
* Watchdog
608603

609604
* Added MCUX WWDT driver for LPC SoCs.
610-
* Enhanced Gecko driver to support Gecko Series 2 SoC
605+
* Enhanced Gecko driver to support Gecko Series 2 SoC.
611606

612607
* WiFi
613608

@@ -617,7 +612,6 @@ Drivers and Sensors
617612
* Fixed esp driver GPIO reset control logic.
618613
* Fixed eswifi driver offloading packet parsing.
619614

620-
621615
Networking
622616
**********
623617

@@ -681,11 +675,10 @@ Networking
681675
* Fixed LWM2M updating lifetime on Register Update event.
682676
* Fixed MQTT double CONNACK event notification on server reject.
683677

684-
685678
Bluetooth
686679
*********
687680

688-
* Host:
681+
* Host
689682

690683
* Added basic support for Isochronous Channels (also known as LE Audio).
691684
* Added support for Periodic Advertising (both Advertising and Scanning
@@ -717,13 +710,13 @@ Bluetooth
717710
discovers it.
718711
* Multiple additional fixes.
719712

720-
* Mesh:
713+
* Mesh
721714

722715
* Added support for storage of model data in a key-value fashion.
723716
* Added support for a network loopback.
724717
* Multiple qualification-related fixes.
725718

726-
* BLE split software Controller:
719+
* BLE split software Controller
727720

728721
* The advanced scheduling algorithms that were supported in the legacy
729722
Controller have been ported to the split one.
@@ -738,7 +731,7 @@ Bluetooth
738731
impact in the cooperation between the flash driver and the Controller.
739732
* Fixed an null pointer dereference in the ticker code.
740733

741-
* HCI Driver:
734+
* HCI Driver
742735

743736
* A new BT_QUIRK_NO_AUTO_DLE has been added for Controllers that do not follow
744737
the recommendation of auto-initating the data length update procedure. This
@@ -747,22 +740,20 @@ Bluetooth
747740
Build and Infrastructure
748741
************************
749742

750-
* Improved support for additional toolchains
751-
752-
* Better toolchain abstractions
753-
* Support for the ARC MetaWare toolchain
743+
* Improved support for additional toolchains:
754744

745+
* Better toolchain abstractions.
746+
* Support for the ARC MetaWare toolchain.
755747

756-
* Devicetree:
748+
* Devicetree
757749

758750
* Added new devicetree macros that provide a default value if the property
759-
or cell accessor doesn't contain the requested data
751+
or cell accessor doesn't contain the requested data.
760752

761753
* Added support for inferring bindings for ``/zephyr,user`` devicetree node
762754
to allow applications an easy way to specify application specific
763755
devicetree properties without having a binding.
764756

765-
766757
* Support for multiple SOC and ARCH roots.
767758
The :ref:`SOC_ROOT <application>` and ``ARCH_ROOT`` variables used to specify
768759
support files for out of tree SoCs and architectures now accept multiple
@@ -780,47 +771,42 @@ Libraries / Subsystems
780771

781772
* Disk
782773

783-
784774
* Management
785775

786-
* MCUmgr:
776+
* MCUmgr
787777

788778
* Moved mcumgr into its own directory.
789779
* UDP port switched to using kernel stack.
790780
* smp: added missing socket close in error path.
791781

792782
* Added support for Open Supervised Device Protocol (OSDP), see :option:`CONFIG_OSDP`.
793783

794-
* updatehub:
784+
* updatehub
795785

796786
* Added download block check.
797787
* Added support to flash integrity check using SHA-256 algorithm.
798788
* Moved updatehub from lib to subsys/mgmt directory.
799789
* Fixed out-of-bounds access and add flash_img_init return value check.
800790
* Fixed getaddrinfo resource leak.
801791

802-
803-
* Settings:
792+
* Settings
804793

805794
* If a setting read is attempted from a channel that doesn't support reading return an error rather than faulting.
806-
* disallow modifying the content of a static subtree name.
807-
795+
* Disallow modifying the content of a static subtree name.
808796

809797
* Random
810798

799+
* POSIX subsystem
811800

812-
* POSIX subsystem:
813-
801+
* Power management
814802

815-
* Power management:
816-
817-
* Logging:
803+
* Logging
818804

819805
* Fixed immediate logging with multiple backends.
820806
* Switched logging thread to use kernel stack.
821807
* Allow users to disable all shell backends at one using :option:`CONFIG_SHELL_LOG_BACKEND`.
822808
* Added Spinel protocol logging backend.
823-
* Fixed timestamp calculation when using NEWLIB
809+
* Fixed timestamp calculation when using NEWLIB.
824810

825811
* LVGL
826812

@@ -854,7 +840,7 @@ Libraries / Subsystems
854840
library footprint when some options are not enabled, so you should wait for
855841
future releases if higher ROM usage is a concern for your application.
856842

857-
* Shell:
843+
* Shell
858844

859845
* Switched to use kernel stacks.
860846
* Fixed select command.
@@ -864,16 +850,17 @@ Libraries / Subsystems
864850
In 2.3 extra arguments caused a fault. Now the shell will report that
865851
the command cannot be processed.
866852

853+
* Storage
867854

868-
* Storage:
869855
* Added flash SHA-256 integrity check.
870856

871-
* Tracing:
857+
* Tracing
858+
872859
* Tracing backed API now checks if init function exists prio to calling it.
873860

874-
* Debug:
861+
* Debug
875862

876-
* Core Dump:
863+
* Core Dump
877864

878865
* Added the ability to do core dump when fatal error is encountered.
879866
This allows dumping the CPU registers and memory content for offline
@@ -891,9 +878,9 @@ HALs
891878
Documentation
892879
*************
893880

894-
895881
Tests and Samples
896882
*****************
883+
897884
* nvs: Do full chip erase when flashing.
898885
* nrf: onoff_level_lighting_vnd_app: Fixed build with mcumgr.
899886
* drivers: flash_shell: new commands write_unaligned and write_pattern.

0 commit comments

Comments
 (0)