It is important to include license and terms of use information
in the documentation for external modules. This helps users
understand their rights and obligations when using these modules
within the Zephyr project.
Signed-off-by: Gillian Minnehan <gillian.minnehan@nordicsemi.no>
This fixes the issue where --list-tests and --test-tree commands
showed duplicated testsuite IDs in the output,
simplifies testcase name handling in harness and runner modules.
Removed feature to extend behaviour of --no-detailed-test-id to shorten
test case names - feature was introduced in #82302.
This makes the twister output more predictable and the codebase easier
to maintain.
Signed-off-by: Grzegorz Chwierut <grzegorz.chwierut@nordicsemi.no>
Move west sdk documentation to the Zephyr-specific west commands page
and clarify listing, interactive install behavior, and toolchain
selection.
Signed-off-by: Ritesh Kudkelwar <ritesh.kumar0793@gmail.com>
Add Doxygen guidelines to help maintain code documentation consistency
across the project in particular for constructs or commands that are Zephyr
specific, such as properly documenting API symbols that are gated by
Kconfig.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Add support for boards to specify flash_before in their board YAML files,
which is then used by pytest and shell harnesses. This is needed for
Synopsys ARC development boards (hsdk, hsdk/arc_hsdk/2cores, hsdk4xd
and iotdk) where the USB serial port disconnects during flashing.
Signed-off-by: Mohamed Moawad <moawad@synopsys.com>
The group display names don't work with dnf5.
As displaynames can depend on the locale and are not unique
dnf5 only supports the group identifiers.
Distributions with dnf4 like RHEL<=10, Fedora<41, and CentOS stream
shouldn't have any issues with the group id, but have not been tested.
Alternatives considered: use the @-sytax for groups introduced in dnf5,
but using the group command makes it more clear that package groups are
installed.
Signed-off-by: Thomas Stranger <thomas.stranger@outlook.com>
Add documentation for the Edge Impulse SDK Zephyr module to the external
modules section, including:
- Module overview describing the Edge Impulse ML development platform
- Integration instructions with west.yml manifest configuration
- West extension commands (ei-build, ei-deploy) for model deployment
- License information (BSD-3-Clause-Clear)
- References to official Edge Impulse documentation and tutorials
The Edge Impulse SDK module enables machine learning inference on Zephyr
devices by packaging the Edge Impulse SDK as a reusable Zephyr module
with west integration for streamlined ML model deployment workflows.
Signed-off-by: Eoin Jordan <eoin@edgeimpulse.com>
The setup.sh script of the Zephyr SDK runs "which cmake"
to find out whether CMake and wget are installed:
71df6c27da/scripts/template_setup_posix (L43)
"which" is not installed by default on Arch Linux,
so the check will fail and the script will yield:
Zephyr SDK setup requires 'cmake' to be installed
and available in the PATH.
Please install 'cmake and run this script again.
Although CMake is already installed.
Fix this by adding "which" to the list of dependencies.
Signed-off-by: Stefan Gloor <code@stefan-gloor.ch>
The existing documentation was not explicit on how qualifiers should be
combined with board revisions. This commit makes it explicit and adds a
concrete example.
Signed-off-by: Nick Brook <nrbrook@gmail.com>
Document the new multiple UART connection support in pytest-twister-harness
plugin. Hardware devices can now access multiple connections using the
connection_index parameter (0=main UART, 1=second core UART).
Also update readlines_until() examples to use explicit regex= parameter
for improved API clarity.
Signed-off-by: Grzegorz Chwierut <grzegorz.chwierut@nordicsemi.no>
On non-Windows systems execute a new program, replacing the west packages
call, when trying to install packages using pip.
For Windows, update the documented way of installing python packages,
or using 'west packages pip --install' print a warning.
Signed-off-by: Pieter De Gendt <pieter.degendt@basalte.be>
Move reference labels within definitions so that they do not break the
flow of definition lists.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Fixes documents where blocks where indented to the right of their parent
causing them to render as definition lists.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Documentation for west blobs `--cache-dirs` and `--auto-cache`,
respectively config options `blobs.cache-dirs` and `blobs.auto-cache`.
Signed-off-by: Thorsten Klein <Thorsten.Klein@bshg.com>
Move lz4 to become external module. It is not in the default manifest
anymore (through submanifests) and will need to be added if application
requires it per the docs.
Samples will be moved to the module itself.
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
Introduce documentation for using dtsh (a Devicetree Shell)
as an external module in Zephyr.
This module installs a West extension.
See also RFC #59863.
Signed-off-by: Christophe Dufaza <chris@openmarl.org>
C99 has been the minimum required C standard version for Zephyr since
its inception. After multiple attempts and discussions, a decision has
been made to upgrade to C17 going forward.
This commits replaces the default C standard from C99 to C17 in the
configuration and build system, and deprecates support for the older
standards.
Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
Running unit tests on macOS or Windows is currently not supported due to
fundamental differences in the architectures. Added a note in the
"Quick start - Unit testing" section about this restriction.
Signed-off-by: Martin Lampacher <martin.lampacher@gmail.com>
Add a section about the old legacy HLA interface being deprecated in
OpenOCD and give some hint on how to accommodate if one faces a
communication issue with an old ST-Link adapter.
Signed-off-by: Etienne Carriere <etienne.carriere@st.com>
Update documentation for using multiple serial ports
with Twister's --devise-serial option.
Signed-off-by: Grzegorz Chwierut <grzegorz.chwierut@nordicsemi.no>
Add documentation for the DT filtering expressions in 'expr_parser.py',
used by Twister to filter boards based on their DT nodes/properties when
selecting test scenarios.
Signed-off-by: Abderrahmane JARMOUNI <git@jarmouni.me>
The display harness initial documentation was a separate, stale (had
references to a personal Github repo), README.rst buried in the
twister/scripts folder.
Move the docs to be a "first class" part of the Twister documentation
alongside other harnesses.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Add a new 'west bindesc extract' subcommand that dumps all binary
descriptors into a separate binary file. It will also report the range
(offset and length) of the dumped data within the original image.
Signed-off-by: Luca Burelli <l.burelli@arduino.cc>
The Python version installed with winget defaults to 3.8, make a more
recent version the default.
Also add a note on the execution policy for activating the Python virtual
environment.
Signed-off-by: Pieter De Gendt <pieter.degendt@basalte.be>
Add a west config option to skip rebuilds by default or not when doing
west flash. Also add corresponding symmetrical CLI options.
Signed-off-by: Declan Snyder <declan.snyder@nxp.com>
Introduce documentation for using mender-mcu as an external module in
Zephyr.
Signed-off-by: Daniel Skinstad Drabitzius <daniel.drabitzius@northern.tech>
This commit adds support for IAR C-STAT Static Analysis
in the Zephyr's SCA Framework.
By specifying -DZEPHYR_SCA_VARIANT=iar_c_stat in west, a SQLite
database file will be generated under build/sca/iar_c_stat.
Signed-off-by: Felipe Torrezan <felipe.torrezan@iar.com>
