Commit Graph

7767 Commits

Author SHA1 Message Date
Alberto Escolar Piedras
fe5753a393 docs: Remove references to native_posix pages
The native_posix pages are going to be removed from the tree, let's
remove references to them.

Signed-off-by: Alberto Escolar Piedras <alberto.escolar.piedras@nordicsemi.no>
2025-03-07 19:16:14 +01:00
Fabio Baltieri
400403dd70 doc: release: finalize release notes and migration guide
Drop the "working draft" suffix from the release notes and migration
guide page titles for 4.1.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2025-03-07 17:34:55 +00:00
Fabio Baltieri
1d3f7fbf48 doc: release: add v4.1.0 to the list of supported releases
Add 4.1.0 to the supported release, EOL to the tentative 4.3 release
date.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2025-03-07 17:34:55 +00:00
Abderrahmane JARMOUNI
6402eb6e97 doc: scripts: board catalog: skip zephyr compats
Skip "zephyr,xxx" compats when collecting data for the new Supported
Features table, since they don't represent hardware features.

Signed-off-by: Abderrahmane JARMOUNI <git@jarmouni.me>
2025-03-07 10:23:47 +00:00
Benjamin Cabé
a97dca9123 doc: release-notes-4.1: complete list of notable changes
Add details about:
- Driver API improvements with iterable sections and device API checking
- Enhanced board catalog with hardware feature search and generation of
  table of supported hardware features

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-03-07 09:44:25 +00:00
Riadh Ghaddab
f3630157e0 doc: settings: add reference to ZMS backend
Add reference to the new settings backend ZMS and add more details about
how it works.

Signed-off-by: Riadh Ghaddab <rghaddab@baylibre.com>
2025-03-06 12:48:50 +01:00
Peter Mitsis
c9a96477d0 doc: Update direct ISR documentation
Updates the direct ISR documentation to make it more clear that
direct ISR handlers should be declared using ISR_DIRECT_DECLARE().

Fixes #85683

Signed-off-by: Peter Mitsis <peter.mitsis@intel.com>
2025-03-05 21:54:48 +00:00
Benjamin Cabé
930898b49d doc: css: update board.css to prevent text overflow
Ensure no scrollbar is ever shown when compatible overflows and gets
ellipsized.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-03-05 19:05:28 +00:00
Fabio Baltieri
fe4ae781bc doc: LICENSING: Add BSD-3-clause for python-devicetree test files
Update the licensing list to include the BSD-3-clause devicetree test
files. These were all introduced in:

ee5c520326 edtlib: tests: refine coverage of Binding objects
  initialization

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2025-03-05 19:05:19 +00:00
Jamie McCrae
6888aba5bd doc: sysbuild: Add note on configuring board roots
Adds a note on how these should be configured

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2025-03-05 09:58:26 +00:00
Jamie McCrae
0504136a94 doc: build: sysbuild: Add documentation on image setup
Adds detailed documentation on how images can be added and how
configuration of images can be controlled from sysbuild

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2025-03-05 09:58:26 +00:00
Benjamin Cabé
c0f76d9363 doc: Update Graphviz font configuration
Customize Graphviz dot rendering to use same font stack as our Sphinx
theme.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-03-05 00:15:48 +00:00
Benjamin Cabé
fd919b5160 doc: make graphviz diagrams look good in dark theme
Add filter to invert colors in dark mode.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-03-05 00:15:37 +00:00
Benjamin Cabé
4ddfe10b89 doc: boards: extensions: simplify DTS binding description extraction
Previous implementation was unneccesarily complex, and cutting of
words such as "802.15.4" to "802.".

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-03-04 18:26:07 +00:00
Benjamin Cabé
fdb8b30da7 doc: extensions: Navigate to DTS entries from supported hardware list
Update the gen_board_catalog.py logic to also capture lineno for
each devicetree node. Use that info in the supported hardware list to
create clickable elements that directly take the user to the
corresponding line in the devicetree file on Github.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-03-04 17:28:57 +01:00
Benjamin Cabé
235fabb06b doc: _extensions: simplify legend creation
Use raw HTML as there's no point in having lots of docutils
boilerplate for what's effectively static content

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-03-04 17:28:57 +01:00
Jukka Rissanen
094d233fc3 doc: release-notes: Add 4.1.0 release notes for Ethernet
Add 4.1.0 release notes for Ethernet.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
2025-03-04 04:03:50 +01:00
Arrel Neumiller
4f0b8d0daf doc: Improve context for thread identity in scheduling
Enhance the description around reschedule points to provide more
context about the current thread's identity. This update clarifies
that changing the identity of the current thread involves switching
the CPU's execution from one thread to another.

Signed-off-by: Arrel Neumiller <rlneumiller@gmail.com>

doc: Improve context for thread identity in scheduling

Enhance the description around reschedule points to provide more
context about the current thread's identity. This update clarifies
that changing the identity of the current thread involves switching
the CPU's execution from one thread to another.

Signed-off-by: Arrel Neumiller <rlneumiller@gmail.com>
2025-03-03 21:14:22 +01:00
Håvard Reierstad
c7a19da8ca Bluetooth: Host: Improve more GATT documentation
Adds improvement to the GATT API documentation by providing examples of
where (and how) certain structs are used, and adds specification
references to the fields of bt_gatt_cpf to clarify their purpose.

Signed-off-by: Håvard Reierstad <haavard.reierstad@nordicsemi.no>
2025-03-03 14:44:14 +01:00
Robert Lubos
6b6cc6c687 doc: release-notes: Add 4.1.0 release notes for networking
Add 4.1.0 release notes for networking.

Signed-off-by: Robert Lubos <robert.lubos@nordicsemi.no>
2025-03-03 14:43:00 +01:00
Tomáš Juřena
be52f3e1bd doc: release-notes: Move NXP watchdog text
The description of the change is listed under wifi but it should be
watchdog instead.

Signed-off-by: Tomáš Juřena <jurenatomas@gmail.com>
2025-03-03 14:33:44 +01:00
Pieter De Gendt
c0c6047257 doc: develop: getting_started: Add powershell tabs
Activating the Python environment on Windows can be done in a regular
command line prompt, or in powershell. But the activation script is
different.
Add a code tabs to include the powershell alternative.

Signed-off-by: Pieter De Gendt <pieter.degendt@basalte.be>
2025-02-28 14:52:30 +01:00
Benjamin Cabé
8438c47a0b boards: ene: adopt new zephyr:board directive and role
This updates the documentation of all the ENE Technology boards to use
the new `zephyr:board::` directive.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-02-28 14:52:23 +01:00
Måns Ansgariusson
762861defd doc: Add k_pipe deprecation notice to 4.1 release notes
Add a notice to the 4.1 release notes that CONFIG_PIPES k_pipe
implementation is deprecated from 4.1.

Signed-off-by: Måns Ansgariusson <Mansgariusson@gmail.com>
2025-02-28 14:52:03 +01:00
Benjamin Cabé
95c1c850bc doc: extensions: Add line reference support to zephyr_file/zephyr_module
Enhance the zephyr_file link role to support referencing specific lines
or line ranges in files.
This change allows users to link to exact locations within a file
using GitHub-style line references.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-02-28 10:10:47 +01:00
Benjamin Cabé
d15bbfafef doc: releases: Zephyr 4.1 release highlights
A first stab at adding some highlights for the upcoming 4.1 release.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-02-27 13:26:56 +00:00
Benjamin Cabé
6060f07189 doc: toolchain: add reference label for IAR Arm Toolchain documentation
Add anchor to be able to reference this page from other places.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-02-27 13:26:56 +00:00
Jordan Yates
5ad76de07f secure_storage: swap select to depends on
Mixing `select` and `depends on` is a common source of Kconfig
dependency loops and should be avoided. Both `ZMS` and `SETTINGS` are
more commonly used with `depends on` rather than `select`.

The usage here also contradicts the Zephyr best practices guide for
`select`:
 * Avoid selecting symbols with prompts or dependencies.
   Prefer depends on.

Signed-off-by: Jordan Yates <jordan@embeint.com>
2025-02-27 09:07:56 +00:00
David Brown
68a5a95f2b docs: develop: languages: Add initial documentation for Rust
Start a simple set of documentation on using Rust within Zephyr.  This
gives an overview of how to use Rust, and pointers to the generated API
documentation.

Signed-off-by: David Brown <david.brown@linaro.org>
2025-02-27 09:07:42 +00:00
Daniel Leung
88968b970c doc: release/4.1: add bits about I3C
This adds some bits about changes in I3C drivers in the release
note.

Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2025-02-27 09:07:26 +00:00
Daniel Leung
634403f093 doc: release/4.1: add bits about common architecture interface
This adds bits in the release note on changes in common
architecture interface, where the changes affect more than one
architectures.

Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2025-02-27 09:07:26 +00:00
Vinayak Kariappa Chettimada
1cc6bab2ee doc: Update to release notes update scope and purpose
Update the scope and purpose of release notes to include
style, typographical fixes and upmerge from maintenance
releases to keep the latest documentation consistent with
the changes in the project.

Signed-off-by: Vinayak Kariappa Chettimada <vich@nordicsemi.no>
2025-02-27 08:01:29 +01:00
Flavio Ceolin
902751411f doc: release-notes-4.1: Add CVE-2025-1675
Add CVE-2025-1675 to release notes.

Signed-off-by: Flavio Ceolin <flavio@hubblenetwork.com>
2025-02-27 08:01:08 +01:00
Flavio Ceolin
3918c86b1a doc: release-notes-4.1: Add CVE-2025-1674
Add CVE-2025-1674 to release notes.

Signed-off-by: Flavio Ceolin <flavio@hubblenetwork.com>
2025-02-27 08:01:08 +01:00
Flavio Ceolin
5a0d4675a8 doc: release-notes-4.1: Add CVE-2025-1673
Add CVE-2025-1673 to release notes.

Signed-off-by: Flavio Ceolin <flavio@hubblenetwork.com>
2025-02-27 08:01:08 +01:00
Flavio Ceolin
bc189229ac doc: security: Disclose CVE-2025-1675
Disclose information about published CVE.

Signed-off-by: Flavio Ceolin <flavio@hubblenetwork.com>
2025-02-27 08:01:08 +01:00
Flavio Ceolin
b777714e2a doc: security: Disclose CVE-2025-1674
Disclose information about published CVE.

Signed-off-by: Flavio Ceolin <flavio@hubblenetwork.com>
2025-02-27 08:01:08 +01:00
Flavio Ceolin
48f15dda9f doc: security: Disclose CVE-2025-1673
Disclose information about published CVE.

Signed-off-by: Flavio Ceolin <flavio@hubblenetwork.com>
2025-02-27 08:01:08 +01:00
Jamie McCrae
01c5edcd5c doc: serices: device_mgmt: smp_groups: smp_group_1: Add doc anchor
Adds an anchor so that the section text can be linked to

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2025-02-26 22:04:36 +00:00
Declan Snyder
d46c382950 drivers: ethernet: Remove deprecated eth_mcux
This driver was deprecated and must be removed by Zephyr version
4.1 according to lifecycle/release guidelines.

Signed-off-by: Declan Snyder <declan.snyder@nxp.com>
2025-02-26 22:04:26 +00:00
Benjamin Cabé
22ed2f73d4 doc: Enhance board supported hardware directive and catalog generation
Improve the board supported hardware feature catalog generation and
`.. zephyr:board-supported-hw` directive:

- Differentiate on-chip vs on-board hardware features
- Added count information when a given IP (compatible) appears multiple
  times.
- Show okay *and* disabled features
- Improve table layout and readability

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-02-26 22:02:39 +00:00
Benjamin Cabé
424d15a259 doc: _extensions: create dedicated board.css/js files
Don't clutter custom.css with css rules and scripts only used in boards'
doc pages.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-02-26 22:02:39 +00:00
Anas Nashif
ac082d17b6 doc: contrib: remove outdated note about rebases
The button for rebasing PRs is not available anymore, so this note does
not apply and will only cause confusion, remove it.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2025-02-26 01:37:21 +01:00
Anas Nashif
6ca79bba72 doc: contrib: clarify twister support
Twister works on all OSes with different levels of features/targets
supported, so clarify the message.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2025-02-26 01:37:21 +01:00
Butch Warns
141561fc1e doc: fix debug/informational options wrong defaults
Fixes: #86021
Documentation erroneously states CONFIG_DEBUG option is enabled by default.

Signed-off-by: Butch Warns <contact@butchwarns.de>
2025-02-25 20:39:10 +01:00
Guillaume Gautier
6cf1ecbeff doc: develop: tools: add doc to debug with stm32cubeide
Add documentation to use STM32CubeIDE for debug only.

Signed-off-by: Guillaume Gautier <guillaume.gautier-ext@st.com>
2025-02-25 15:13:57 +00:00
Jamie McCrae
d2698a17ac doc: migration: 4.1: Add note on deprecated macro removal
Adds a note about removing this deprecated macro

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2025-02-25 15:13:42 +00:00
Duy Nguyen
9cbbad1a05 doc: releases: Add missing item of Renesas vendor
Add information about EK-RA2L1 support.
Add information about RZ CPG driver support.

Signed-off-by: Duy Nguyen <duy.nguyen.xa@renesas.com>
2025-02-24 15:37:31 +00:00
Derek Snell
b5de6307d2 doc: getting_started: Install Perl in Windows
Perl is required for check_compliance.py/checkpatch.pl, and needs to be
installed in Windows to run these scripts.

Signed-off-by: Derek Snell <derek.snell@nxp.com>
2025-02-22 07:10:57 +01:00
Benjamin Cabé
efbe277d20 doc: ci: pin to Sphinx < 8.2.0
Sphinx 8.2.0 was just released but doesn't seem to work all that well
for PDF generation. Stick to 8.1.x for now.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-02-21 18:35:44 +00:00