Commit graph

92 commits

Author SHA1 Message Date
Jordan Yates 07870934e3 everywhere: replace double words
Treewide search and replace on a range of double word combinations:
    * `the the`
    * `to to`
    * `if if`
    * `that that`
    * `on on`
    * `is is`
    * `from from`

Signed-off-by: Jordan Yates <jordan@embeint.com>
2024-06-22 05:40:22 -04:00
Pisit Sawangvonganan f51c8ee739 doc: releases: fix typo
Utilize a code spell-checking tool to scan for and correct spelling errors
in all files within the doc/releases directory.

The typo in the 'Issue Related Items' section will be left unchanged.

Signed-off-by: Pisit Sawangvonganan <pisit@ndrsolution.com>
2024-01-25 18:14:31 -05:00
Dmitry Lukyantsev 34a966f219 doc: Fix a typo
Fix a typo in the spelling of "current".
Add "current" to spelling.txt.

Signed-off-by: Dmitry Lukyantsev <dmitrylu@google.com>
2023-08-04 21:18:43 +00:00
Gerard Marull-Paretas 260deccb6e doc: use :kconfig:option: domain role
Kconfig options now belong to the Kconfig domain, therefore, the
:kconfig:option: role needs to be used.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-03-02 09:28:37 +01:00
Gerard Marull-Paretas 459c3f918f doc: drop single quote references
Many documents relied on single quotes to create references, e.g.
`my_reference`. This is possible because `default_role = "any"` is
enabled in Sphinx conf.py. However, this method comes with its problems:

- It mixes all domains together, so it's not clear to what are you
  referencing: a document? a Kconfig option? a C function?...
- It creates inconsistencies: in some places explicit roles are used
  (e.g. :ref:`my_page`) while in some others not.
- _Conflictis_ with markdown. Single quotes are used for literals in
  Markdown, so people tend to use the same syntax in Sphinx, even though
  it has a different purpose.

Usages have been found using `git grep ' `[^`]*` ' -- **/*.rst`.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2021-12-10 16:43:34 -05:00
Gerard Marull-Paretas 92b338e239 pm: remove deprecated Kconfig options
SYS_POWER_MANAGEMENT and DEVICE_POWER_MANAGEMENT were deprecated in
2.5.0, remove them now.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2021-10-28 13:00:13 +02:00
Gerard Marull-Paretas 838380bb63 doc: fix C domain reference usage
THis patch fixes multiple issues when referencing to the C domain. In
some cases there were typos (e.g. missing :), in some others no domain
syntax was used for referencing, etc.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2021-10-26 10:57:45 +02:00
Gerard Marull-Paretas 9dfbdf1997 doc: use kconfig role and directive
Stop using :option: for Kconfig options.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2021-06-29 10:26:28 -04:00
Dominik Ermel ebeb8fbeed release: Fix LittleFS entry in 2.5 release notes
The document build system has been complaining about use of
no longer existing Kconfig option.

Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
2021-06-23 10:03:14 -05:00
Anas Nashif 39d7d34710 release: add more fixes issues to notes
Add more resolved issues to notes.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2021-02-14 09:58:55 -05:00
Anas Nashif 554fca0e5c release: make release notes final
Remove "Working Draft" from title.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2021-02-14 09:58:55 -05:00
Andrzej Głąbek c2b5e68953 doc: release-notes-2.5: Add notes for ADC and PWM
Plus one note about the nrf_qspi_nor driver.

Signed-off-by: Andrzej Głąbek <andrzej.glabek@nordicsemi.no>
2021-02-12 11:06:40 -05:00
Jennifer Williams af81648a18 doc: releases: 2.5: add misc x86 to boards and socs
Add misc changes still needed in release notes for
x86 Boards and SoCs after checking their history:
- zefi.py: Use cross compiler while building zephyr
- boards: x86: ehl_crb: Add board variant for Slim Bootloader
- tests: enable the code coverage report for qemu_x86_64
- drivers/timer: Remove legacy APIC driver
- x86: add common memory.ld
- x86: reserve the first megabyte

Signed-off-by: Jennifer Williams <jennifer.m.williams@intel.com>
2021-02-11 16:57:12 -05:00
Jennifer Williams 54b7439cae doc: releases: fix format issue in Boards & SoCs
Remove extra space character which is causing wrong format for
the bulleted list.

Signed-off-by: Jennifer Williams <jennifer.m.williams@intel.com>
2021-02-11 14:38:48 -05:00
Anas Nashif e8317920b1 release notes: add top level bullets, misc. changes
Add top level bullets and misc. changes to other areas.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2021-02-11 12:55:18 -05:00
Anas Nashif 5a605778f8 release: add resolved issues
Add list of all resolved issues since 2.4.0.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2021-02-11 12:55:18 -05:00
Johann Fischer 902dd26908 doc: release-notes-2.5: add release notes for USB
Add release notes for USB.

Signed-off-by: Johann Fischer <johann.fischer@nordicsemi.no>
2021-02-11 08:53:00 -05:00
Andrzej Puzdrowski c7f1f2c269 doc: releasenotes 2.5: Add notes on addition fs_dir_t_init
The commit adds notes on addition on fs_dir_t_init function and its
impact on File system API.

Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
2021-02-10 08:53:17 -05:00
Flavio Ceolin 81315757cf doc: release-notes-2.5: crypto libraries
Add information about mbedTLS.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2021-02-10 07:14:53 -05:00
Flavio Ceolin 9d7457a586 doc: release-notes-2.5: Vulnerabilities addressed
Add information about vulnerabilities addressed during this release
cycle.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2021-02-10 07:14:53 -05:00
Flavio Ceolin 5a2f25a7c3 doc: release-notes-2.5: Power management contents
Add some high-level bullets about power management changes in 2.5.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2021-02-08 18:02:23 -05:00
Daniel Leung 0b8fd86784 doc: release-notes-2.5: memory management related items
This adds a few lines about changes to memory management,
introduction of demand paging, and changes to x86 memory
management code.

Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2021-02-08 17:29:32 -05:00
Jennifer Williams a8c91fd97c doc: release-notes-2.5: boards and SoCs: x86 ehl_crb acrn_ehl_crb
This adds a few lines for newly added board and SoC defintions
for Elkhart Lake (ehl_crb) and ACRN configurations (acrn_ehl_crb).

Signed-off-by: Jennifer Williams <jennifer.m.williams@intel.com>
2021-02-08 16:25:29 -05:00
Daniel Leung c1a41a4490 doc: release-notes-2.5: kernel: add info on thread local storage
This adds a few lines about thread local storage that is being
introduced in this release.

Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2021-02-08 16:24:40 -05:00
Martin Jäger adfd947fc7 doc: release: Add DAC release notes for v2.5.0
Adding notes regarding new TI driver and enabled support for some
more STM32 series.

Signed-off-by: Martin Jäger <martin@libre.solar>
2021-02-08 16:24:22 -05:00
Carlo Caione 484abf51f2 doc: release: v2.5.0 release notes for ARM AArch64
Zephyr v2.5.0 release notes for AArch64 architecture.

Signed-off-by: Carlo Caione <ccaione@baylibre.com>
2021-02-08 14:39:11 -05:00
Ioannis Glaropoulos 7e42108890 doc: release: v2.5.0 release notes for ARM AARCH32
Zephyr v2.5.0 release notes for AARCH32 architecture.

Signed-off-by: Ioannis Glaropoulos <Ioannis.Glaropoulos@nordicsemi.no>
2021-02-08 14:38:53 -05:00
Peter Bigot a00740995b doc: release-notes-2.5: I2C
High-level changes in I2C subsystem since 2.4.0.

Signed-off-by: Peter Bigot <peter.bigot@nordicsemi.no>
2021-02-08 12:26:18 -05:00
Eugeniy Paltsev b9ec64b448 doc: release notes: ARC
2.5 release notes for ARC related changes

Signed-off-by: Eugeniy Paltsev <Eugeniy.Paltsev@synopsys.com>
2021-02-08 11:49:21 -05:00
Martí Bolívar df2980acfe doc: release-notes-2.5: devicetree
New macros etc.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2021-02-08 08:26:42 -05:00
Martí Bolívar 78ec3223e7 doc: release-notes-2.5: s/device tree/devicetree/
This is the preferred way to write it.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2021-02-08 08:26:42 -05:00
Maureen Helm 46d6a73f91 doc: release: Add NXP-related changes to v2.5.0 release notes
Adds v2.5.0 release notes for NXP boards and drivers.

Signed-off-by: Maureen Helm <maureen.helm@nxp.com>
2021-02-05 17:19:26 -05:00
Maureen Helm 59074044d9 doc: release: Add sensor changes to v2.5.0 release notes
Fills in the sensor drivers section of the v2.5.0 release notes.

Signed-off-by: Maureen Helm <maureen.helm@nxp.com>
2021-02-05 17:19:26 -05:00
Jukka Rissanen 599f21da62 doc: net: Add networking changes to 2.5 release note
Initial set of networking related changes in 2.5 release.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2021-02-04 09:37:18 -05:00
Ioannis Glaropoulos 7471729273 doc: release notes: a note for changing the default FP mode in ARM
Adding a note in the v2.5.0 release notes to reflect
that we have changed the default FP services mode from
unshared to shared, for ARM Cortex-M.

Signed-off-by: Ioannis Glaropoulos <Ioannis.Glaropoulos@nordicsemi.no>
2021-02-02 17:58:58 -05:00
Erwan Gouriou e36aece07e doc: release-notes-2.5: Shields Additions
Add mention for Sharp generic shield addition.

Signed-off-by: Erwan Gouriou <erwan.gouriou@linaro.org>
2021-02-02 12:30:08 -05:00
Erwan Gouriou 5be45d827d doc: release-notes-2.5: STM32 Additions
STM32 additions for V2.5.0 release.

Signed-off-by: Erwan Gouriou <erwan.gouriou@linaro.org>
2021-02-02 12:30:08 -05:00
Joakim Andersson b20b5c0d44 Bluetooth: host: Deprecate the bt_set_id_addr API function
Deprecate the bt_set_id_addr API function. This is merely a wrapper
for the bt_id_create function now, except an IRK cannot be given.
When CONFIG_BT_PRIVACY is enabled an IRK has to be given by the
application because the bt_rand function cannot be called before
bt_enable.

Signed-off-by: Joakim Andersson <joakim.andersson@nordicsemi.no>
2021-02-02 08:46:17 -05:00
Dominik Ermel c8d1c3ba2c doc: releasenotes 2.5: Add notes on addition fs_file_t_init
The commit adds notes on addition on fs_file_t_init function and its
impact on File system API.

Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
2021-02-02 07:36:44 -05:00
Henrik Brix Andersen e9f386a62c doc: releases: 2.5: add EEPROM release notes for v2.5
Add EEPROM release notes for v2.5.

Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
2021-02-02 07:17:49 -05:00
Peter Bigot d91fd612a1 doc: release: 2.5: document deprecated littlefs Kconfig options
Note that Kconfig options related to the filecache memory pool have been
deprecated and replaced by a Kconfig option for configuring the
filecache heap size.

Signed-off-by: Peter Bigot <peter.bigot@nordicsemi.no>
2021-02-02 07:15:17 -05:00
Peter Bigot 1ee82a1c9b doc: release: 2.5: note build-time resolution of device pointers
Document the existence of new API to retrieve device pointers at build
time.

Signed-off-by: Peter Bigot <peter.bigot@nordicsemi.no>
2021-02-01 22:10:51 -05:00
Andy Ross eb52f98305 release-notes-2.5: Note k_mem_pool removal
This is a removed API, should be called out here.  Also include a
behavioral note, as I don't think we did in release notes this when
k_heap was introduced.

Signed-off-by: Andy Ross <andrew.j.ross@intel.com>
2021-02-01 21:41:19 -05:00
Alexander Wachter 681173c9ed doc: releasenotes 2.5: Add CAN driver release notes
This commit adds the release notes for the 2.5 releas for
the CAN driver.

Signed-off-by: Alexander Wachter <alexander@wachter.cloud>
2021-01-31 10:21:15 -05:00
Joakim Andersson c14da53772 Bluetooth: host: Remove the deprecated bt_conn_create_slave_le function
Remove the deprecated bt_conn_create_slave_le function.
This was deprecated in the 2.3.0 release.

Signed-off-by: Joakim Andersson <joakim.andersson@nordicsemi.no>
2021-01-29 12:53:10 -05:00
Joakim Andersson 016b580beb Bluetooth: host: remove deprecated bt_conn_security function
Remove the deprecated bt_conn_security function.
This has been deprecated in the 2.3.0 release.

Signed-off-by: Joakim Andersson <joakim.andersson@nordicsemi.no>
2021-01-29 12:53:10 -05:00
Joakim Andersson 58e4263efb Bluetooth: host: Remove deprecated connection create API functions.
Remove the deprecated connection create API functions.
These have been deprecated in the 2.3.0 release.

Signed-off-by: Joakim Andersson <joakim.andersson@nordicsemi.no>
2021-01-29 12:53:10 -05:00
Joakim Andersson 6485a660fe Bluetooth: host: Remove the deprecated Advertising Types definitions
Remove the deprecated Advertising Types definitions.
These have been deprecated in the 2.3.0 release.

Signed-off-by: Joakim Andersson <joakim.andersson@nordicsemi.no>
2021-01-29 12:53:10 -05:00
Joakim Andersson 5f2a9ba8e4 Bluetooth: host: Remove deprecated security defines
Remove the deprecated security level define and the HCI error
code for authentication failure.
These have been deprecated since the 2.0.0 release.

Signed-off-by: Joakim Andersson <joakim.andersson@nordicsemi.no>
2021-01-29 12:53:10 -05:00
Joakim Andersson a0d62f03a0 Bluetooth: host: Remove deprecated scan filter duplicate params
Remove the deprecated scan filter duplicate enum values and parameter.
This was deprecated for the 2.3.0 release.

Signed-off-by: Joakim Andersson <joakim.andersson@nordicsemi.no>
2021-01-29 12:53:10 -05:00