Commit Graph

5125 Commits

Author SHA1 Message Date
Benjamin Cabé 84263962b0 doc: fixed stale link to sbs emulator
Fixed bad link reported by Sphinx linkchecker

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-06-07 04:40:47 -04:00
Benjamin Cabé b7e23b88ce doc: pinctrl: fix link to ELC2021 slide deck
updated link to point to a working location.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-06-07 04:40:47 -04:00
Benjamin Cabé c77811500c doc: mcumgr: update link to mcumgr root folder
MCUmgr does not live in subsys/mgmt/mcumgr/lib anymore.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-06-07 04:40:47 -04:00
Benjamin Cabé 46f7c044c0 doc: i2c: fixed non-working link to I2C spec
Fixed improperly formatted link to I2C spec.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-06-07 04:40:47 -04:00
Benjamin Cabé 21c1a61551 doc: peripherals: fix bad link to Display API
fixed incorrect link reference to Display API

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-06-07 04:40:47 -04:00
Benjamin Cabé 8cbe2d83b4 doc: snippets: fix bad link
Fixed incorrect reference to snippets/ folder

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-06-07 04:40:47 -04:00
Benjamin Cabé 4ef2493203 west: doc: update link to SPDX doc
fixed 404 link to SPDX documentation

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-06-07 04:40:47 -04:00
Benjamin Cabé a76396fb7a doc: update stale links to MCUboot documentation
mcuboot.com/documentation --> docs.mcuboot.com

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-06-07 04:40:47 -04:00
Benjamin Cabé 23f2a2066f doc: update stale srecord links
Updated 404 links to point to valid locations.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-06-07 04:40:47 -04:00
Benjamin Cabé 7ed56d559e doc: release-notes: fix bad links
Added missing include/ to fix dead links re: iterable sections API

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-06-07 04:40:47 -04:00
Martin Jäger 7b2034aaec doc: develop: api: overview: tag DAC API as Unstable
Promote DAC API from Experimental to Unstable.

The API is well adopted and used in more than 2 implementations.

Signed-off-by: Martin Jäger <martin@libre.solar>
2023-06-06 17:21:06 -04:00
Martin Jäger 059e56497e doc: develop: api: overview: tag Task Watchdog API as Unstable
Promote Task Watchdog API from Experimental to Unstable.

The API has proven to be suitable for its purpose.

Signed-off-by: Martin Jäger <martin@libre.solar>
2023-06-06 17:20:51 -04:00
Gerard Marull-Paretas 619b285aa8 doc: doxygen: move data structure APIs to utilities group
These are utility APIs for data structures, so put them under the
utilities group.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2023-06-05 20:21:09 -04:00
Gerard Marull-Paretas 97f219414a dox: doxygen: add third_party group
Add a new top-level group for APIs that interact with third-party
services or applications. Included in the group:

- MCUboot image control API
- Hawkbit
- UpdateHub

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2023-06-05 20:21:09 -04:00
Gerard Marull-Paretas d753ff7d5b doc: doxygen: define missing mcumgr group
Add a new group, under os_services, for MCUmgr (was used without a
definition).

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2023-06-05 20:21:09 -04:00
Gerard Marull-Paretas 866c176410 doc: doxygen: create utilities group
Add a new top-level for general utilities, like utility functions,
linear range API, time utils, etc. This category should be used by stuff
that is not strictly bound to the OS, like are OS services.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2023-06-05 20:21:09 -04:00
Gerard Marull-Paretas 30946d46fd usb: create top-level usb Doxygen group
Create a USB Doxygen group, part of the top-level connectivity group.
Added some existing groups to the usb group, note that USB Doxygen needs
to be improved, though.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2023-06-05 20:21:09 -04:00
Gerard Marull-Paretas 9a806e9c8a doc: doxygen: add new connectivity group
Add a new connectivity group and add to it the following other groups:

- LoRaWAN
- Networking
- Bluetooth

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2023-06-05 20:21:09 -04:00
Jamie McCrae 52b0295775 doc: release: 3.4: Add notes on MCUmgr changes
Adds notes on MCUmgr changes (and an MCUboot change).

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-06-05 08:31:25 -04:00
Martí Bolívar 98810bc7a1 doc: west: v1.0.1 and v1.1.0 release notes
Add release notes and update relevant documentation pages
for these releases.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2023-06-04 16:52:20 -07:00
Martí Bolívar afb341d065 doc: west: fix group filter documentation
The docs about how this works are inconsistent. Fix it by
adjusting the docs so they all match the implementation and
are consistent with each other.

Earlier in this page:

    Manifest files which appear earlier in the import order have
    higher precedence and are therefore concatenated later into the
    final group-filter.

Where for "import order" we have:

    Importing is done in this order:

    1. Manifests from self-import are imported first.
    2. The top-level manifest file’s definitions are handled next.
    3. Manifests from import-1, …, import-N, are imported in that order.

Therefore, "filter-1 to filter-N" is the wrong precedence order. It
should be "filter-N to filter-1", so that filter-N is lower precedence
than filter-1. That is consistent with import-1 happening before
import-N.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2023-06-04 16:52:20 -07:00
Martí Bolívar bf5cc876e6 doc: west: troubleshooting: fix path
Make the text align with the code block.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2023-06-04 16:52:20 -07:00
Martí Bolívar 5d72602cc4 doc: west: improve "version:" documentation
Consolidate information from release-notes.rst into
a new table describing the manifest file format features
which were introduced in each version of west.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2023-06-04 16:52:20 -07:00
Martí Bolívar 9e12ff4264 doc: west: clarify import example YAML
Fine-tuning for clarity.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2023-06-04 16:52:20 -07:00
Flavio Ceolin 40312a8578 doc: vulnerabilities: Add information about CVE-2023-0779
Add information about CVE-2023-0779

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2023-06-02 18:59:27 -04:00
Flavio Ceolin d3193eae33 doc: vulnerabilities: Add information about CVE-2023-0397
Add information about CVE-2023-0397

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2023-06-02 18:59:27 -04:00
Andrei Emeltchenko 21f59903c7 doc: smbus: Correct SMBus documentation
Fix syntax errors in the documentation.

Signed-off-by: Andrei Emeltchenko <andrei.emeltchenko@intel.com>
2023-06-01 18:04:58 -04:00
Chris Friedt 2aec275dd7 doc: releases: update LTSv2 release date and version
Update the LTSv2 release date and link to documentation.

Signed-off-by: Christopher Friedt <cfriedt@meta.com>
2023-06-01 18:03:50 -04:00
Flavio Ceolin 50e35fad8d doc: pm: Add a note about multicore behavior
Add a note to make it clear devices suspension order in
multicore systems.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2023-06-01 06:32:47 -04:00
Gerard Marull-Paretas 49ec35fe5e testsuite: group all test-related APIs under 'testing'
Before this change we had 2 top-level Doxygen entries for Testing APIs:

- Zephyr tests
- Zephyr testing suite

This patch creates a single top-level group to contain ZTest and FFF
extensions.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2023-05-31 14:39:29 -04:00
Gerard Marull-Paretas a98d673230 doc: doxygen: s/subsys/os_services
Rename the subsystems group from `subsys` to `os_services`, aligning
with what we have on the Sphinx side.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2023-05-31 14:39:29 -04:00
Carlo Caione 5a8025da12 doc: release-notes: Add ARM64, IPC and API entries
Owned by the author (myself).

Signed-off-by: Carlo Caione <ccaione@baylibre.com>
2023-05-31 06:15:32 -04:00
Carlo Caione f5c66e9708 doc: Add barriers API docs
Add an entry to the barriers API in the docs.

Signed-off-by: Carlo Caione <ccaione@baylibre.com>
2023-05-31 06:15:32 -04:00
Stine Åkredalen 2921fc9d5e doc: Bluetooth: mesh: add large composition data docs
Added basic description of Large Composition Data server and
client models.

Signed-off-by: Stine Åkredalen <stine.akredalen@nordicsemi.no>
2023-05-31 10:22:32 +01:00
Filip Kokosinski e6672e025f doc/releases: add RISC-V release notes for Zephyr v3.4
This commit adds RISC-V release notes for Zephyr v3.4.

Signed-off-by: Filip Kokosinski <fkokosinski@antmicro.com>
2023-05-30 10:50:15 -04:00
Gerard Marull-Paretas 8a56405808 doc: release-notes: add iterable sections changes
The API resides now in a new header.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2023-05-30 08:58:48 -04:00
Gerard Marull-Paretas 9d8eea80cc doc: release-notes: add Twister changes
Add relevant Twister changes.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2023-05-30 08:58:48 -04:00
Gerard Marull-Paretas 9a7cb2194c doc: release-notes: inform about COMPILER_TRACK_MACRO_EXPANSION
This option is relevant enough to appear in the release notes, since it
is helpful to ease the debugging of a frequent issue.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2023-05-30 08:58:48 -04:00
Gerard Marull-Paretas 88c0f64b2e doc: release-notes: add PM changes
Add relevant power-management changes.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2023-05-30 08:58:48 -04:00
Gerard Marull-Paretas a5937cdd4e doc: release-notes: add device model changes
Inform about relevant changes to the device model.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2023-05-30 08:58:48 -04:00
Gerard Marull-Paretas 3e505737c6 doc: release-notes: add regulators release notes
Add relevant changes to the regulator driver class.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2023-05-30 08:58:48 -04:00
Gerard Marull-Paretas 6ceb802f84 doc: release-notes: add pinctrl changes
Add new driver additions for pinctrl.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2023-05-30 08:58:48 -04:00
Gerard Marull-Paretas 57f21993a6 doc: release-notes: inform about pinmux removal
Pinmux API has been removed in favor of pin control.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2023-05-30 08:58:48 -04:00
Gerard Marull-Paretas c502a119e9 doc: release-notes: remove dead TF-M entry
TF-M changes are documented in another section of the document, this is
likely a merge mistake.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2023-05-30 08:58:48 -04:00
Eivind Jølsgard 0ce3e20bfb boards: arm: nrf9160dk: change order of buttons on IO expander
Change order of buttons and switches on the nRF9160DK IO expander to
match the configuration without the IO expander.

Follow-up to commit d565aa2.

Signed-off-by: Eivind Jølsgard <eivind.jolsgard@nordicsemi.no>
2023-05-29 13:05:25 +02:00
Nick Ward b1b0a36ca8 doc: pm: power_domain: fix spelling of below
Fix spelling of below

Signed-off-by: Nick Ward <nix.ward@gmail.com>
2023-05-29 05:21:10 -04:00
Jamie McCrae d8d119fd9c doc: release: 3.4: Add auxdisplay addition node
Adds a note on unstable auxiliary display support being added,
alongside 3 drivers.

Signed-off-by: Jamie McCrae <spam@helper3000.net>
2023-05-26 23:05:58 +02:00
Jamie McCrae 71e7cf888d doc: api: Add auxdisplay as unstable API
Adds the new auxiliary display peripheral as an unstable API.

Signed-off-by: Jamie McCrae <spam@helper3000.net>
2023-05-26 23:05:58 +02:00
Jamie McCrae 71e10e743c doc: hardware: peripheral: Add auxdisplay documentation
Adds base auxdisplay documentation.

Signed-off-by: Jamie McCrae <spam@helper3000.net>
2023-05-26 23:05:58 +02:00
Rodrigo Peixoto 1cbcaecac3 doc: zbus: improve suggested uses
Developers may be uncertain about which observer type to use in zbus,
potentially resulting in improper subsystem use. Fix that by adding an
explicit differentiation between the observer's type in the `Suggested
uses` section.

Fixes #58004

Signed-off-by: Rodrigo Peixoto <rodrigopex@gmail.com>
2023-05-26 14:56:28 -04:00