Commit Graph

8198 Commits

Author SHA1 Message Date
Daniel DeGrasse
bde3e6929b doc: release: Finalize v4.2.0 release notes and migration guide
Remove working draft status from the v4.2.0 release notes and migration
guide.

Signed-off-by: Dan Kalowsky <dkalowsky@amperecomputing.com>
Signed-off-by: Daniel DeGrasse <ddegrasse@tenstorrent.com>
2025-07-18 18:17:09 -05:00
Daniel DeGrasse
dd20c8e210 doc: release: Remove v4.0.0 from the list of supported releases
Only the two most recent mainline releases are supported.

Signed-off-by: Dan Kalowsky <dkalowsky@amperecomputing.com>
Signed-off-by: Daniel DeGrasse <ddegrasse@tenstorrent.com>
2025-07-18 18:17:09 -05:00
Daniel DeGrasse
8178c87c1c doc: release: add v4.2.0 to the list of supported releases
Add 4.2.0 to the supported release, EOL to the tentative 4.4 release
date.

Signed-off-by: Dan Kalowsky <dkalowsky@amperecomputing.com>
Signed-off-by: Daniel DeGrasse <ddegrasse@tenstorrent.com>
2025-07-18 18:17:09 -05:00
Daniel DeGrasse
1ba9504811 doc: releases: enforce sorting of entries
Enforce sorting of entries, using zephyr-keep-sorted. This will make
sure that entries don't get out of order again within the release notes
or migration guide by throwing a compliance error.

Note that autogenerated areas do not have this enforcement enabled.

Signed-off-by: Daniel DeGrasse <ddegrasse@tenstorrent.com>
2025-07-18 09:35:31 -07:00
Daniel DeGrasse
f821de4d88 doc: releases: 4.2: clean up entry order
Clean up order of entries to be alphabetically sorted in the "new apis"
section

Signed-off-by: Daniel DeGrasse <ddegrasse@tenstorrent.com>
2025-07-18 09:35:31 -07:00
Daniel DeGrasse
db64d7bd5f doc: releases: migration-guide: clean up entry order
Clean up order of entries in the migration guide to be alphabetical.
Combine two duplicate regulator sections, and move driver sections
mistakenly placed under networking where they ought to be.

Signed-off-by: Daniel DeGrasse <ddegrasse@tenstorrent.com>
2025-07-18 09:35:31 -07:00
Erwan Gouriou
4ab5efc87d release-notes: 4.2: Add a clarification on a new compatible
Clarify the introduction of st,stm32-ethernet-controller compatible
so that reader could not understand that this is the introduction of
STM32 ethernet (while it is only dts shenanigans).

Signed-off-by: Erwan Gouriou <erwan.gouriou@st.com>
2025-07-18 09:38:39 -05:00
Abderrahmane JARMOUNI
366d45fd34 doc: release-notes-4.2: Add Display notable changes
Add Display notable additions in 4.2 release.

Signed-off-by: Abderrahmane JARMOUNI <git@jarmouni.me>
2025-07-17 17:36:40 -10:00
Abderrahmane JARMOUNI
a1455b4dfc doc: release-notes4.2: Add LVGL notable changes in Zephyr
Add LVGL notable changes in Zephyr

Signed-off-by: Abderrahmane JARMOUNI <git@jarmouni.me>
2025-07-17 19:03:41 -05:00
Benjamin Cabé
62ffbb0127 doc: releases: 4.2: Consolidate release highlights
Add twister power harness mention
Use same structure as the one used for 4.1

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-07-17 19:03:28 -05:00
Benjamin Cabé
d9045ea467 twister: doc: add anchors for various harness sections
Make it possible to cross reference documentation for various harnesses
by adding target locations.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-07-17 19:03:28 -05:00
Benjamin Cabé
b46b41dd79 doc: releases: 4.2: Misc. typo and spelling fixes
General clean up of small typos and other trivial fixes.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-07-17 19:03:28 -05:00
Krzysztof Chruściński
8fa515419c doc: releases: Add note about de-deprecation in Nordic UART driver
Add note in release notes for v4.2 about de-deprecation of
CONFIG_CONFIG_UART_x_NRF_HW_ASYNC option.

Signed-off-by: Krzysztof Chruściński <krzysztof.chruscinski@nordicsemi.no>
2025-07-17 12:46:31 -10:00
Etienne Carriere
72dc0e5f0a doc: migration: 4.2: Note on STM32 TF-M BL2 HW crypto
Add a note about STM32 boards TF-M BL2 bootloader that do not embed
HW crypto drivers since migration to TF-M v2.2.

Signed-off-by: Etienne Carriere <etienne.carriere@st.com>
2025-07-17 11:29:53 -05:00
Maksim Salau
7ab9d8b668 doc: migration: 4.2: Add Modbus related notes
Add notes regarding changes in Modbus  serial mode configuration.

Signed-off-by: Maksim Salau <maksim.salau@gmail.com>
2025-07-16 16:41:02 -05:00
Jeppe Odgaard
2e14671749 doc: services: storage: fcb: remove deprecated settings recommendation
The recommended back-end depends on the use case. There exists another note
(recommendation) in doc/services/storage/settings/index.rst which is up to
date.

Signed-off-by: Jeppe Odgaard <jeppe.odgaard@prevas.dk>
2025-07-16 16:40:43 -05:00
Ryan McClelland
d84348fbd1 docs: device: remove action for device pm
It is not possible to go from ACTIVE to OFF with device pm
actions.

Signed-off-by: Ryan McClelland <ryanmcclelland@meta.com>
2025-07-16 05:22:47 -10:00
Christoph Mair
ab3c514d33 doc: migration: 4.2: typo: NET_REQUEST_ETHERNET_GET_QAV_PARAM used twice
The migration guide mentions NET_REQUEST_ETHERNET_GET_QAV_PARAM twice
in a row. One instance should be NET_REQUEST_ETHERNET_SET_QAV_PARAM.

Signed-off-by: Christoph Mair <christoph.mair@husqvarnagroup.com>
2025-07-15 08:34:34 -10:00
Nabil Elqatib
b663ee861f doc: kernel: drivers: Correct number of initialization levels
Commit a0b746 deleted 2 deprecated driver init levels (EARLY,
APPLICATION), but didn't update the number mentioned in the doc.

Signed-off-by: Nabil Elqatib <nabilelqatib@gmail.com>
2025-07-15 08:34:21 -10:00
Lyle Zhu
328a96cb65 doc: releases: 4.2: Mention Bluetooth Classic changes
Add the changes of Bluetooth Classic to release notes.

Signed-off-by: Lyle Zhu <lyle.zhu@nxp.com>
2025-07-14 11:18:09 -10:00
Daniel Leung
388f7677fb doc: release-notes/4.2: add bits about I3C
Add bits about I3C on added/removed kconfigs, and a new driver.

Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2025-07-14 07:09:33 -10:00
Benjamin Cabé
defe9ecb25 doc: develop: manifests: external: add zenoh-pico
Introduce documentation for using zenoh-pico as an external module in
Zephyr.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-07-11 15:54:17 -05:00
Robert Lubos
2c097a4c00 doc: release-notes: Add 4.2.0 release notes for networking
Add 4.2.0 release notes for networking and move the PM section which
somehow ended up inside Networking.

Signed-off-by: Robert Lubos <robert.lubos@nordicsemi.no>
2025-07-11 13:44:54 -05:00
Jamie McCrae
066226edd6 doc: release: 4.2: Add MCUmgr changes
Adds new features/APIs for MCUmgr

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2025-07-11 13:44:47 -05:00
Jamie McCrae
cd0fb8a75c doc: release: 4.2: Add sysbuild changes
Adds new features for sysbuild

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2025-07-11 13:44:47 -05:00
Jamie McCrae
90d7d2c6ff doc: migration: 4.2: Add note on HWMv1
Adds a note that HWMv1 support has now been dropped

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2025-07-11 13:44:47 -05:00
Benjamin Cabé
4f0bbb8fda doc: _static: css: fix navtree +/- icon margins
Fixed selectors that probably went stale overtime since the custom.css
was adopted from Godot and RTD having evolved in the meantime and that
were causing +/- icons to expand/collapse the navtree to be putting
margins where they shouldn't have.

Fixes zephyrproject-rtos/zephyr#78974

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-07-11 13:44:37 -05:00
Benjamin Cabé
ee173abeb3 doc: doxygen: use STRIP_FROM_INC_PATH to keep #includes clean
Another take on zephyrproject-rtos/zephyr#76953.
This uses STRIP_FROM_INC_PATH to make sure #include snippets in the
documentation are not absolute paths and reflect what one would
actually use in their code.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-07-11 13:44:27 -05:00
Benjamin Cabé
4f747cea90 doc: release-notes-4.2: update highlights sections
Add a few bullet points calling out the major highlights of Zephyr 4.2.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-07-11 08:16:46 -10:00
Josuah Demangeon
2aba7112cb doc: release-note-4.2: add new video-related API
Document new API introduced for video drivers as visible on the
<zephyr/drivers/video.h> header.

Signed-off-by: Josuah Demangeon <me@josuah.net>
2025-07-10 16:07:27 -05:00
Josuah Demangeon
4f585fd7f5 doc: migration-guide-4.2: add video-related API changes
Document API changes affecting video drivers as visible on the
<zephyr/drivers/video.h> header.

Signed-off-by: Josuah Demangeon <me@josuah.net>
2025-07-10 16:07:27 -05:00
Josuah Demangeon
424ad06a33 doc: release-notes-4.2: improve formatting of video notes
Use :c:func:`xxx` and :c:type:`xxx` when applicable, as well as reword
a deprecation to make the replacement appear.

Signed-off-by: Josuah Demangeon <me@josuah.net>
2025-07-10 16:07:27 -05:00
Josuah Demangeon
cce8e488d1 doc: migration-guide-4.2: improve formatting of video-related notes
Use :c:func:`xxx` and :c:enum:`xxx` instead of plain ``xxx`` when it is
possible.

Signed-off-by: Josuah Demangeon <me@josuah.net>
2025-07-10 16:07:27 -05:00
Josuah Demangeon
d4914965d8 doc: releases: mention the video selection API functions
Add a mention to the video_set_selection() and video_get_selection()
introduced in #91878.

Signed-off-by: Josuah Demangeon <me@josuah.net>
2025-07-10 16:07:27 -05:00
Benjamin Cabé
7561eff012 doc: _doxygen: fix doxygen awesome dark theme
Fix issues with Doxygen 1.14 and dark theme. Upstream PRs to
doxygen-awesome will be submitted in parallel.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-07-10 16:07:18 -05:00
Flavio Ceolin
4591461b55 doc: vuln: Add CVE under embargo
Add an entry to CVE-2025-7403

Signed-off-by: Flavio Ceolin <flavio@hubblenetwork.com>
2025-07-10 16:07:10 -05:00
Flavio Ceolin
fe9b1f557f doc: release/4.2: Add CVE under embargo
Add information about CVE under embargo.

Signed-off-by: Flavio Ceolin <flavio@hubblenetwork.com>
2025-07-10 16:07:10 -05:00
Benjamin Cabé
cae12e6d6a doc: twister: inline twister --help output into the docs
In order to make it easier for folks to discover available twister
options when using/searching the documentation, or when making external
search in their favorite search engine, inline the output of
`twister --help` into the docs so as to have an always up-to-date
and searchable snapshot of it.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-07-10 16:01:34 -05:00
Martin Hoff
1ede94dda3 doc: releases: introduce release notes and migration guide docs for 4.3
This introduces the release notes and migration guide for Zephyr 4.3.0
earlier so that people have a placeholder to start adding content as
they line up pull requests for the 4.3 release.

Signed-off-by: Martin Hoff <martin.hoff@silabs.com>
2025-07-10 10:13:58 -05:00
Benjamin Cabé
4d98db4a45 doc: doxygen: update doxygen awesome to v2.3.4
No major changes but compatibility is improved with Doxygen 1.12.0.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-07-08 13:41:02 -05:00
Benjamin Cabé
5b56e4dc02 .github: workflows: Bump Doxygen to 1.14 from 1.12
Doxygen 1.14 comes with really useful UX improvements which we want to
benefit from in our API documentation so update the CI job accordingly.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-07-08 13:41:02 -05:00
Fin Maaß
d53e9519a1 docs: replace clock_gettime
the time() implementation now uses
sys_clock_gettime(), change that in the docs.

Signed-off-by: Fin Maaß <f.maass@vogl-electronic.com>
2025-07-08 13:38:11 -05:00
Daniel DeGrasse
980afc8fdf doc: releases: 4.2: add notes for mbedtls 3.6.4 update
Add release notes for mbedtls 3.6.4 update, including CVEs resolved with
this release.

Signed-off-by: Daniel DeGrasse <ddegrasse@tenstorrent.com>
2025-07-08 11:05:53 -05:00
Benjamin Cabé
732785aefa doc: develop: gsg: consolidate python3 install instructions for ubuntu
- Installing python3-venv should be done right when all dependencies are
  installed.
- Installing python3-venv is enough to pull wheel, setuptools
  (python3-setuptools-whl), and pip (python3-pip-whl) so that they are
  available in the venv, so reduce the list of packages to install
  accordingly.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-07-07 16:06:24 -05:00
Benjamin Cabé
6ddf0f48e7 doc: develop: gsg: move from ubuntu 20.04 to 22.04 as minimum version
Ubuntu 20.04 has entered "security fixes only" mode since May 2025, so
we can simplify the getting started guide by making the instructions
apply to 22.04 and onwards, and remove the instructions for adding
Kitware APT repository in the process.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-07-07 16:06:24 -05:00
Benjamin Cabé
d7ff0e4ba4 doc: develop: gsg: have west init use pinned Zephyr version for releases
When building the docs for a release, the section of the getting started
that lets the user `west init` their workspace now has them check out
the version matchin the release.

Fixes zephyrproject-rtos/zephyr#92163

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-07-07 10:12:41 -05:00
Josuah Demangeon
b3ccee473e doc: release-notes-4.2: add mentions to the new UVC class
Add references to new API, functions, devicetree bindings introduced
from introduction of the UVC class.

Signed-off-by: Josuah Demangeon <me@josuah.net>
2025-07-05 11:56:10 -05:00
Benjamin Cabé
f672cb72d4 Revert "doc: ci: Zephyr now requires Python 3.12 or higher"
This reverts commit 043bb58488.

Note that  scripts/requirements-actions.txt might not be 100% the same
as what was pinned prior to the revert due to it being difficult to
restore previous versions while also accounting for the new dependencies
that were added in the meantime.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-07-04 15:50:06 -05:00
Benjamin Cabé
33d6061fe7 Revert "doc: correct python minimum required"
This reverts commit c68d0b9630.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-07-04 15:50:06 -05:00
Benjamin Cabé
3b365fbe54 doc: releases: Intermediate update for new 4.2 boards/samples/drivers
New boards, drivers, samples, and shields since June 10, 2025

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-07-04 13:09:52 -05:00