Skip to content

Commit 62d97cd

Browse files
dbkindergalak
authored andcommitted
doc: (Final) release notes edit prior to release
Final edit pass on the release notes prior to 1.10 release. Fixed misspellings in GitHub issues title (here and in GitHub). Updated doc changes. Signed-off-by: David B. Kinder <[email protected]>
1 parent 6a61d5f commit 62d97cd

File tree

1 file changed

+26
-20
lines changed

1 file changed

+26
-20
lines changed

doc/release-notes-1.10.rst

Lines changed: 26 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ Kernel
3131
* k_mem_domain_remove_thread() - to remove a thread from a domain
3232
* add k_calloc() which uses kernel heap to implement traditional calloc()
3333
semantics.
34-
* Introduce object validation mechanism: All system calls made from userspace
35-
which involve pointers to kernel objects (including device drivers) will need
34+
* Introduce object validation mechanism: All system calls made from userspace,
35+
which involve pointers to kernel objects (including device drivers), will need
3636
to have those pointers validated; userspace must never be able to crash the
3737
kernel by passing it garbage.
3838

@@ -77,12 +77,12 @@ Networking
7777
* HTTP API changed to use net-app API. Old HTTP API is deprecated.
7878
* Loopback network interface support added. This is used in testing only.
7979
* LWM2M multi-fragment network packet support added.
80-
* New CoAP library implementation which supports longer network packets.
80+
* New CoAP library implementation, supporting longer network packets.
8181
* Old ZoAP library deprecated.
8282
* mDNS (multicast DNS) support added.
8383
* SNTP (Simple Network Time Protocol) client library added.
8484
* Various fixes for: TCP, RPL, ARP, DNS, LWM2M, Ethernet, net-app API, Network
85-
shell, BSD socket API
85+
shell, and BSD socket API
8686
* Network management API fixes.
8787
* Networking sample application fixes.
8888
* 6lo IPv6 header compression fixes.
@@ -146,19 +146,22 @@ Documentation
146146

147147
* Missing API documentation caused by doxygen subgroups and missing
148148
Sphinx directives now included.
149-
* Note added to release doc pages mentioning more current content could
149+
* Note added to all released doc pages mentioning more current content could
150150
be available from the master branch version of the documentation.
151-
* Documentation updated to use CMake (vs. Make) in all examples.
151+
* Documentation updated to use CMake (vs. Make) in all examples, and
152+
using a new Sphinx extension to keep examples consistent.
152153
* Getting Started Guide material updated to include CMake dependencies
153-
and build instructions.
154+
and build instructions required for version 1.10.
154155
* Instead of hiding all expected warnings from the document build
155156
process (there are some known doxygen/sphinx issues), the build
156157
now outputs all warnings, and then reports
157158
if any new/unexpected warnings or errors were detected.
158159
* Obsolete V1 to V2 porting material removed.
159160
* Continued updates to documentation for new board support, new samples,
160161
and new features.
161-
* Integration of documentation with new zephyrproject.org website
162+
* Integration of documentation with new zephyrproject.org website.
163+
* Documentation moved to docs.zephyrproject.org site (with redirection
164+
from zephyrproject.org/doc)
162165

163166
Tests and Samples
164167
*****************
@@ -170,6 +173,9 @@ Tests and Samples
170173
Issue Related Items
171174
*******************
172175

176+
These GitHub issues were addressed since the previous 1.9.0 tagged
177+
release:
178+
173179
.. comment List derived from Jira/GitHub Issue query: ...
174180
175181
* :github:`779` - CI: shippable - provide some means to allow users to rebuild
@@ -207,7 +213,7 @@ Issue Related Items
207213
* :github:`1544` - regression: net: K64F: DHCP seems to fail a lot after 91041f9e
208214
* :github:`1558` - Master reports itself as if it was 1.9.0 release
209215
* :github:`1571` - Update to latest tinycrypt: v0.2.8
210-
* :github:`1573` - tests/net/lib/http_header_fields/ fails with CONFIG_HTTP_PARSER_STRICT enabeld
216+
* :github:`1573` - tests/net/lib/http_header_fields/ fails with CONFIG_HTTP_PARSER_STRICT enabled
211217
* :github:`1580` - checkpatch output in shippable log displays without line breaks
212218
* :github:`1581` - two tests fail in qemu_cortex_m3 with new SDK
213219
* :github:`1597` - remove deprecated k_mem_pool_defrag()
@@ -224,7 +230,7 @@ Issue Related Items
224230
* :github:`1885` - Display Interface
225231
* :github:`1902` - uWeave
226232
* :github:`2011` - tcf: add support for running altera_max10 binaries
227-
* :github:`2035` - doc: remove workaround for sphinx issue once 1.5 is releaed
233+
* :github:`2035` - doc: remove workaround for sphinx issue once 1.5 is released
228234
* :github:`2202` - sporadic bad RAM pointer error under qemu_nios2
229235
* :github:`2277` - Update to a more recent version of micro-ecc in Zephyr
230236
* :github:`2281` - purge usage of platform_whitelist
@@ -315,7 +321,7 @@ Issue Related Items
315321
* :github:`4001` - GENERATED_KERNEL_OBJECT_FILES end up in application memory
316322
* :github:`4004` - integrate printk() with console subsystem
317323
* :github:`4009` - I2C API is mixing two incompatible definitions of bit-fields
318-
* :github:`4014` - memory protection: implict kernel object permissions
324+
* :github:`4014` - memory protection: implicit kernel object permissions
319325
* :github:`4016` - bluetooth linker not connected
320326
* :github:`4022` - net: "queue: Use k_poll if enabled" commit regressed BSD Sockets performance
321327
* :github:`4026` - CC3220 WiFi Host Driver support
@@ -336,14 +342,14 @@ Issue Related Items
336342
* :github:`4046` - BLE Central and BLE Peripheral roles at a moment on nRF52832
337343
* :github:`4048` - HTTP Request Timeout Not Working
338344
* :github:`4049` - AMP - Multi-core
339-
* :github:`4050` - zephyr.git/tests/kernel/obj_validation/testcase.yaml#test :Evalution failure
345+
* :github:`4050` - zephyr.git/tests/kernel/obj_validation/testcase.yaml#test :Evaluation failure
340346
* :github:`4051` - Coverity issue seen with CID: 177219 , in file: /drivers/flash/flash_stm32f4x.c
341347
* :github:`4054` - [CID: 177215 ], in file: /tests/subsys/dfu/mcuboot/src/main.c
342348
* :github:`4055` - Coverity issue seen with CID: 177214 , in file: /samples/boards/microbit/pong/src/ble.c
343349
* :github:`4056` - Coverity issue seen with CID: 177213 , in file: /tests/net/ipv6_fragment/src/main.c
344350
* :github:`4057` - Coverity issue seen with CID: 170744, in file: /samples/boards/microbit/pong/src/ble.c
345351
* :github:`4058` - samples/net/http_client: The HTTP client failed to send the GET request
346-
* :github:`4059` - zephyr.git/tests/net/ipv6/testcase.yaml#test :evalution failed
352+
* :github:`4059` - zephyr.git/tests/net/ipv6/testcase.yaml#test :evaluation failed
347353
* :github:`4068` - [BLE, nRF51822] Error -ENOMEM when use bt_gatt_write_without_response function
348354
* :github:`4099` - Add some docs to samples/net/ieee802154/hw
349355
* :github:`4131` - gen_syscalls.py may choke on non-ascii chars
@@ -352,12 +358,12 @@ Issue Related Items
352358
* :github:`4162` - build error in http_get sample
353359
* :github:`4165` - ieee802154_uart_pipe.c: warning: return from incompatible pointer type
354360
* :github:`4182` - NET_APP_SETTINGS for 15.4 doesn't seem to work (if to trust 15.4 shell)
355-
* :github:`4186` - tcf.git/examples/test_network_linux_zephyr.py#_test :Compelition failure
361+
* :github:`4186` - tcf.git/examples/test_network_linux_zephyr.py#_test :Compilation failure
356362
* :github:`4188` - samples /net/echo_server:failed to send packets to client
357363
* :github:`4189` - ieee802154_settings.c is duplicated in the codebase
358364
* :github:`4190` - samples/net/echo_client :failed to send data
359365
* :github:`4193` - Zephyr libc(snprintf) is not comply with ISO standard.
360-
* :github:`4195` - tests/net/udp/test_udp.py#_ipv4_udp : evalution failed
366+
* :github:`4195` - tests/net/udp/test_udp.py#_ipv4_udp : evaluation failed
361367
* :github:`4239` - unit tests broken in sanitycheck
362368
* :github:`4249` - where is auto-pts py script of zephyr?
363369
* :github:`4258` - samples/net/zoap_server : unable to communicate between zoap client and server
@@ -381,7 +387,7 @@ Issue Related Items
381387
* :github:`4395` - Coverity issue seen with CID: 178059
382388
* :github:`4396` - Coverity issue seen with CID: 178060
383389
* :github:`4397` - Coverity issue seen with CID: 178064
384-
* :github:`4398` - zephyr/tests/crypto/ccm_mode :-Evalution failed due to esp32
390+
* :github:`4398` - zephyr/tests/crypto/ccm_mode :-Evaluation failed due to esp32
385391
* :github:`4419` - 6LoWPAN - source address uncompress corner case
386392
* :github:`4421` - net: Duplicated functionality between net_pkt_get_src_addr() and net_context.c:create_sockaddr()
387393
* :github:`4424` - Turning on network debug message w/ LwM2M sample client will result in stack check failure
@@ -459,7 +465,7 @@ Issue Related Items
459465
* :github:`4881` - device_get_binding() returns failure in sample/drivers/crypto
460466
* :github:`4889` - Flashing EM Starterkit with EM7D fails on master
461467
* :github:`4899` - Convert opensda doc to CMake
462-
* :github:`4901` - net: tcp: RST is sent after last ack is recieved
468+
* :github:`4901` - net: tcp: RST is sent after last ack is received
463469
* :github:`4904` - cmake: BOOT_BANNER disappeared
464470
* :github:`4905` - cmake: flashing for quark_se_devboard is broken
465471
* :github:`4910` - BT host CMakeLists.txt code should be agnostic to the FS implementation
@@ -486,12 +492,12 @@ Issue Related Items
486492
* :github:`5060` - [Coverity CID: 179249] Incorrect expression in /tests/kernel/fatal/src/main.c
487493
* :github:`5061` - [Coverity CID: 179248] Control flow issues in /samples/net/zperf/src/zperf_tcp_receiver.c
488494
* :github:`5062` - [Coverity CID: 179247] Incorrect expression in /tests/kernel/fatal/src/main.c
489-
* :github:`5063` - samples/bluetooth: central_hr sample app is not connecting with peripherl sample app on arduino_101.
495+
* :github:`5063` - samples/bluetooth: central_hr sample app is not connecting with peripheral sample app on arduino_101.
490496
* :github:`5085` - bug: dts: stm32f1: wrong pinctrl base address
491497
* :github:`5087` - Samples/bluetooth: Failed to connect with eddystone sample app on arduino_101.
492498
* :github:`5090` - no makefile in zephyr/samples/bluetooth/mesh examples
493499
* :github:`5097` - zephyr_library_*() configuration has lower precedence than global zephyr_*() configuration
494-
* :github:`5107` - Default parition addressing for nrf52_pca10040 is incompatible
500+
* :github:`5107` - Default partition addressing for nrf52_pca10040 is incompatible
495501
* :github:`5116` - [Coverity CID: 179986] Null pointer dereferences in /subsys/bluetooth/host/mesh/access.c
496502
* :github:`5117` - [Coverity CID: 179985] Error handling issues in /subsys/bluetooth/host/mesh/cfg_srv.c
497503
* :github:`5118` - [Coverity CID: 179984] Memory - corruptions in /drivers/ethernet/eth_mcux.c
@@ -514,7 +520,7 @@ Issue Related Items
514520
* :github:`5177` - hci_usb: Linking error
515521
* :github:`5184` - kernel system call handlers missing due to -Wl,--no-whole-archive
516522
* :github:`5186` - gen_syscall_header_py is being run at the wrong time
517-
* :github:`5189` - tests/subsys/fs/nffs_fs_api:-Evalution failed
523+
* :github:`5189` - tests/subsys/fs/nffs_fs_api:-Evaluation failed
518524
* :github:`5207` - Bluetooth subsystem uses acl_in_pool even for controllers not supporting flow control
519525
* :github:`5211` - Kconfig: CPU_HAS_FPU dependencies problem
520526
* :github:`5223` - CMake: Recent changes broke 3rd-party build system integration again

0 commit comments

Comments
 (0)