Commit graph

492 commits

Author SHA1 Message Date
Henrik Brix Andersen
966ef0fefd doc: develop: optimizations: tools: use latest puncover release
Update the documentation to recommend installing the latest puncover
release publiced to the Python Package Index (PyPI).

At the time of this commit, the latest release on PyPI is v0.4.2, which
matches the latest release available on the puncover GitHub repo.

Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
2025-06-19 13:58:40 +02:00
Benjamin Cabé
043bb58488 doc: ci: Zephyr now requires Python 3.12 or higher
Update getting started guide, release notes, CI actions and
Python version compliance check to use Python 3.12 as
minimum supported version.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-06-19 13:56:59 +02:00
Benjamin Cabé
5f099c801b doc: develop: west: document spdx not being supported for native_sim
Generating SPDX SBOMs for the ``native_sim`` platform has propably
never worked, but at least now it will be documented.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-06-18 17:45:16 -04:00
Robin Kastberg
2004c2f7eb doc: Updated IAR toolchain information for coming version
Corrected the installation instructions for the IAR Arm Toolchain
to reflect the latest recommended version.

Signed-off-by: Robin Kastberg <robin.kastberg@iar.com>
2025-06-18 09:11:04 -04:00
Luca Ciucci
24f9ca7178 sca: add HTML summary and full report options to ECLAIR configuration
Introduce ECLAIR_SUMMARY_HTML and ECLAIR_FULL_HTML CMake options to
enable the generation of HTML reports.

Signed-off-by: Luca Ciucci <luca.ciucci@bugseng.com>
2025-06-10 12:53:59 -04:00
Luca Ciucci
d8b86f1ac7 doc: update ECLAIR documentation
Added prerequisites section, fixed some typos and added
ECLAIR_RULESET_ZEPHYR_GUIDELINES option.
Also updated dead doc string links in ECLAIR configuration files.

Signed-off-by: Luca Ciucci <luca.ciucci@bugseng.com>
2025-06-10 12:53:59 -04:00
Benjamin Cabé
be504b000d west: spdx: allow to generate for different SPDX versions
When support for SPDX 2.3 was added, it effectively dropped support for
SPDX 2.2, which in retrospect was a bad idea since SPDX 2.2 is the
version that is the current ISO/IEC standard.
This commit adds a `--spdx-version` option to the `west spdx` command
so that users can generate SPDX 2.2 documents if they want.
Default is 2.3 given that's effectively what shipped for a few releases
now, including latest LTS.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-06-10 13:28:38 +02:00
Carles Cufi
bcf4d1ad38 doc: west: releases: Fix typo
s/manidest/manifest.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2025-05-23 23:49:48 +02:00
Alex Fabre
219fae6946 sca: llvm: add support for clang static analyzer
This commit brings a convenient way to run clang static analyzer on a
project with 'analyze-build' llvm utility.

Signed-off-by: Alex Fabre <alex.fabre@rtone.fr>
2025-05-23 17:40:36 -04:00
Alex Fabre
7e00170fa9 doc: toolchain: ATfE: fix formating
This commit fixe text formatting, removing numbered paragraphs, and
adding sub-titled parts.

Signed-off-by: Alex Fabre <alex.fabre@rtone.fr>
2025-05-23 17:40:36 -04:00
Pieter De Gendt
f8a4b0ad53 doc: develop: west: Update west API for v1.4.0
Update the west API documentation for the added active_only arguments
to as_dict/as_frozen_dict/as_yaml/as_frozen_yaml.

Signed-off-by: Pieter De Gendt <pieter.degendt@basalte.be>
2025-05-22 16:55:44 +02:00
Pieter De Gendt
b18b08a3f0 doc: develop: west: Update release notes
Add release notes for v1.3.0 and v1.4.0.

Signed-off-by: Pieter De Gendt <pieter.degendt@basalte.be>
2025-05-22 16:55:44 +02:00
TOKITA Hiroshi
aaa9d705a9 doc: develop: flash_debug: Add descs about blackmagicprobe and uf2
Add description about blackmagicprobe(host-tools and probes) and
uf2(host-tools only).

Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>
Co-authored-by: Benjamin Cabé <kartben@gmail.com>
Co-authored-by: Andrew Featherstone <andrew.featherstone@gmail.com>
2025-05-21 08:01:36 +02:00
Oleg Zinovyev
2619fb0b9f doc: develop: tools: CLion: update link
Change the link.

Signed-off-by: Oleg Zinovyev <oleg.zinovyev@jetbrains.com>
2025-05-20 15:23:25 +02:00
Anas Nashif
e48c90700d doc: remove more occurances of Nios II
Remove all occurances of Nios II from docs and code.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2025-05-15 20:01:05 -04:00
Chris Friedt
1fc7ccbf96 doc: west: add documentation for west patch
Add documentation for the `west patch` command.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
2025-05-14 19:36:58 +02:00
Mateusz Junkier
04b49fadab twister: harness_config extended by test retries in testcase.yaml
Extend Twister to allow defining repeat counts
for specific scenarios by harness_config.

Signed-off-by: Mateusz Junkier <mateusz.junkier@intel.com>
2025-05-13 03:20:10 +02:00
Anas Nashif
f8647dc94a sca: add coverity as a SCA variant
Add coverity integration as a SCA variant. This is targetting the
service provided by blackduck to open-source projects available on
scan.coverity.com.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2025-05-09 14:01:50 +02:00
Arkadiusz Cholewinski
8be92f86cc Harness: Power harness documentation
Add documentation for power harness.

Signed-off-by: Arkadiusz Cholewinski <arkadiuszx.cholewinski@intel.com>
2025-05-09 14:01:43 +02:00
Benjamin Cabé
e2508389c2 doc: develop: manifests: external: add emlearn
Introduce documentation for using emlearn (TinyML library) as an
external module in Zephyr.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-05-07 13:39:17 +02:00
Tobias Meyer
64fe434297 doc: sbom cmd more detail for build_dir
when following the example it was not clear that BUILD_DIR needs to point
to application for sysbuild builds

Signed-off-by: Tobias Meyer <tobiuhg@gmail.com>
2025-05-05 18:12:09 +02:00
Alex Fabre
1fdad5cc29 doc: toolchain: atfe: arm toolchain for embedded documentation
Arm Toolchain for Embedded (ATfE) is the next-generation Arm embedded
C/C++ compilation toolchain.

Arm Toolchain for Embedded is 100% open source. Arm is investing in the
LLVM linker and minor tools, and in the Picolib C library, to create a
performant 100% open source compilation toolchain for embedded
development with Arm-based designs.

The proprietary components used in Arm Compiler for Embedded 6 (the
linker, C library, and binutils carried over from the legacy Arm
Compiler 5 toolchain) are retired in favour of their open source
(LLVM and Picolib) equivalents.

Product page: https://developer.arm.com/Tools%20and%20Software/Arm%20Toolchain%20for%20Embedded
Github repo: https://github.com/arm/arm-toolchain

Signed-off-by: Alex Fabre <alex.fabre@rtone.fr>
2025-05-02 01:16:08 +02:00
Alex Fabre
6e5554b383 doc: toolchain: ac6: update documentation filename
This update changes the filename from 'arm_compiler.rst' to
'arm_compiler_6.rst' to accurately reflects its focus on AC6.

Recently, Arm introduced the Arm Toolchain for Embedded (ATfE), which is
distinct from AC6. This 7th generation compiler is entirely open source
for the first time. To distinguish it from AC6 and highlight it's a
complete toolchain rather than just a compiler, this new version will
be named Arm Toolchain for Embedded (ATfE).

Signed-off-by: Alex Fabre <alex.fabre@rtone.fr>
2025-05-02 01:16:08 +02:00
Tais Hjortshøj
0709014549 scripts: west_commands: Add powershell autocompletion (west -b)
Windows powershell can by default not autocomplete known boards when
tapping which can cause frustration when you can't quite remember the
exact name or you don't want to type it out.
west build .\path\to\application\ -p -b stm<tab> will search for
available board including 'stm' in their name.

Signed-off-by: Tais Hjortshøj <tbh@mjolner.dk>
2025-05-02 01:16:00 +02:00
Jordan Yates
a5ffd7f7a3 scripts: twisterlib: extend testcase schema for reboots
Extend the testcase schema to provide a way to communicate that a given
test is expected to reboot during execution. The generic harness takes
that information and suppresses `already STARTED` warnings if the
restart is expected.

Signed-off-by: Jordan Yates <jordan@embeint.com>
2025-04-14 13:05:46 +02:00
Benjamin Cabé
f06c26a6d0 doc: extensions: boards: add zephyr:board-supported-runners directive
Use runners.yaml from build metadata to gather info regarding board
supported runners, store the info in the board catalog, and allow
to display it as a table in a board's doc page using the
.. zephyr:board-supported-runner:: directive.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-04-03 21:05:39 +02:00
Peter Johanson
4399d9e3a2 west: runners: rfp: Add Reneses Flash Programmer runner
Add a basic RFP runner that supports the `flash` command targettting
the Renesas Standard Boot Firmware.

Signed-off-by: Peter Johanson <peter@peterjohanson.com>
2025-03-31 19:49:22 -04:00
Benjamin Cabé
776c0cab9a doc: boards: nordic: Adopt zephyr:board directives
Migrate all Nordic boards to leverage the full extent of zephyr:board
directives.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-03-31 22:00:02 +02:00
Grzegorz Chwierut
3acfeafa35 doc: twister: update the quarantine section
Update the quarantine section in the twister.rst documentation
to include information about excluding specific platforms,
architectures, and simulators

Signed-off-by: Grzegorz Chwierut <grzegorz.chwierut@nordicsemi.no>
2025-03-24 19:23:31 +01:00
Carles Cufi
98bea0d957 doc: getting started: windows: Switch to winget
Winget has become the standard Windows package manager, and it already
contains all the packages required for Zephyr development. Switch to it
from Chocolatey for simplicity and consistency with the OS.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2025-03-24 12:13:56 +01:00
Benjamin Cabé
f7ad282504 boards: arduino: doc: Adopt Sphinx custom board directives
Adds zephyr:board and zephyr:board-supported-hw directives to the
Arduino docs in order to generate more of the boards' documentation
automatically.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-03-18 16:40:59 +01:00
Michael Feist
63623915af doc: update Rust documentation to say support Rust instead of CMake
Seemed to be a typo in the Rust doc page saying to enable CMake support
in your CMakeLists.txt. Swapped to say Rust.

Signed-off-by: Michael Feist <michael.feist@etcconnect.com>
2025-03-15 00:36:11 +01:00
Alex Fabre
5ba659c43f sca: gcc: add support for additional analyzer options
This commit brings support for additional GCC static analyzer options
with 'GCC_SCA_OPTS=...'

Linked to discussion on 'ccache' side effect on analyzer file
generation[1]

[1] https://github.com/zephyrproject-rtos/zephyr/discussions/86196

Signed-off-by: Alex Fabre <alex.fabre@rtone.fr>
2025-03-13 16:53:26 +00:00
Martí Bolívar
70efa2b120 doc: document "west gtags" command
Document this command's existence, provide basic usage, and describe
the locations of resources where additional help etc. should be found.

Signed-off-by: Martí Bolívar <marti.bolivar@oss.qualcomm.com>
2025-03-07 19:57:00 +01: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
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é
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
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
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
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é
66a3c6c9ef doc: adopt allowlist/blocklist terminology
Fixed a few occurrences of non-inclusive language.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-02-19 18:48:15 +01:00
Pieter De Gendt
ece3f3b5b6 doc: develop: beyond-GSG.rst: Add west packages to "Keeping Zephyr updated"
Add an entry to the commands to run for "Keeping Zephyr Updated" as
python packages might have been updated/added as dependencies.

Signed-off-by: Pieter De Gendt <pieter.degendt@basalte.be>
2025-02-18 10:07:11 +01:00
Grzegorz Chwierut
df40aa5574 twister: shell harness with commands alongside the harness_config
Allow user to add shell commands in testcase/sample yaml file
alongside the harness_config like in the console harness.

Signed-off-by: Grzegorz Chwierut <grzegorz.chwierut@nordicsemi.no>
2025-02-14 19:14:38 +00:00
Robin Kastberg
c3c5333db5 toolchain: doc: Add toolchain information about IAR
This commit adds documentation information
about the IAR toolchain.

Signed-off-by: Robin Kastberg <robin.kastberg@iar.com>
2025-02-14 19:12:44 +00:00
Emil Gydesen
bf95ad47be docs: Rename BLE to Bluetooth (LE) where applicable
The BLE acronym is not an official description of Bluetooth
LE, and the Bluetooth SIG only ever refers to it as Bluetooth
Low Energy or Bluetooth LE, so Zephyr should as well.

This commit does not change any board or vendor specific
documentation, and the term BLE may still be used in those.
It will be up to the vendors to update it if they want,
since many of them are using the term BLE in their
products.

Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
2025-02-12 12:24:18 +01:00
Anas Nashif
c1f603b9fe doc: twister: add shell harness doc
Document usage of shell harness.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2025-02-08 08:13:46 +01:00
Anas Nashif
49dcc54237 twister: update harness docs
Refine harness docs and move configuration options for each harness into
own section for clarity.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2025-02-08 08:13:46 +01:00
Grant Ramsay
a36c91b4cc doc: gsg: Add note on AArch64 Linux multilib availability
Currently, multilib packages are not available for AArch64 Linux

Signed-off-by: Grant Ramsay <gramsay@enphaseenergy.com>
2025-02-05 08:16:41 +01:00
Johan Hedberg
7a426deae3 doc: gsg: Clarify west workspace naming requirements
The way the instructions were formulated, it was possible for someone to
get the impression that only a specific name of the workspace is allowable.
Clarify that the name and location can be freely chosen.

Signed-off-by: Johan Hedberg <johan.hedberg@silabs.com>
2025-02-04 11:56:40 +01:00