Make it possible to cross reference documentation for various harnesses
by adding target locations.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
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>
- 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>
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>
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.
Fixeszephyrproject-rtos/zephyr#92163
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
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>
Utilize a code spell-checking tool to scan for and correct spelling errors
in various files within the `doc` directory.
In `dsa_txrx_process.svg`, correct the typo `Tansmit` to `Transmit`.
Signed-off-by: Pisit Sawangvonganan <pisit@ndrsolution.com>
Fixes#92059
Update getting started guide, migration-guide and
python.cmake to use Python 3.12.1 as minimum supported
version
Signed-off-by: Tu Nguyen Van <tu.nguyenvan@nxp.com>
Allow overriding puncover default host and port. Using
PUNCOVER_HOST/PUNCOVER_PORT it is possible now to set the host and port
to something else other than the default.
example:
export PUNCOVER_HOST=10.0.1.1
export PUNCOVER_PORT=8088
will start puncover on 10.0.1.1:8088 and make it available over the
local network.
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
The `zephyr-env.sh` script was adjusted to look for the zephyrrc file in
three locations following the [XDG Base Directory Specification]. The
documentation of the environment variables is now adjusted to reflect that
change.
[XDG Base Directory Specification]: (https://specifications.freedesktop.org/basedir-spec/latest/)
Signed-off-by: Andreas Schuster <andreas.schuster@schuam.de>
Add the ST-Link GDB server (part of the STM32CubeCLT) as west runner.
The STM32CubeCLT is an all-in-one multi-OS command-line toolset, which is
part of the STM32Cube ecosystem, and notably includes a GDB server for
debugging using ST-Link probes.
This runner supports the "attach", "debug" and "debugserver" commands.
Documentation: https://www.st.com/en/development-tools/stm32cubeclt.html
Signed-off-by: Mathieu Choplain <mathieu.choplain@st.com>
Clarify that commands should be run from `zephyr` folder.
Fixeszephyrproject-rtos/zephyr#90074
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
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>
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>
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>
Corrected the installation instructions for the IAR Arm Toolchain
to reflect the latest recommended version.
Signed-off-by: Robin Kastberg <robin.kastberg@iar.com>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
Add a basic RFP runner that supports the `flash` command targettting
the Renesas Standard Boot Firmware.
Signed-off-by: Peter Johanson <peter@peterjohanson.com>
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>
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>
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>
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>
