Commit Graph

563 Commits

Author SHA1 Message Date
Benjamin Cabé
fd24cefd01 doc: spelling/typo fixes
minor spelling/typo fixes, mainly around using proper US English

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-12-11 16:32:58 -05:00
Zackery Backman
248151624d doc: develop: manifests: external: add wolfSSH
Add documentation to external module section for adding wolfSSH to Zephyr

Signed-off-by: Zackery Backman <backman23@live.com>
2025-12-06 11:37:53 -05:00
Benjamin Cabé
67cd6120b9 doc: developer: enhance manifest index with introductory text
The "West Projects Index" could use a bit more context so this commit
adds just that.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-12-05 13:38:58 +02:00
Anas Nashif
d1170f668a doc: various fixes for include path
Many include paths missing the zephyr namespace.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2025-11-26 12:11:27 -05:00
Thorsten Klein
d7829271bb doc: develop: west: add documentation for west blobs caches
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>
2025-11-25 13:06:06 +01:00
Anas Nashif
16fecc0276 manifest: optional: move lz4 to external
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>
2025-11-25 13:01:12 +01:00
Anas Nashif
015bf2ed49 manifest: move zscilib to be an external module
Remove from manifest and make it an external module.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2025-11-25 13:01:12 +01:00
Christophe Dufaza
b5744c3158 doc: develop: manifests: external: add dtsh
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>
2025-11-21 10:11:14 +02:00
Carles Cufi
db0c34d836 c standard: Default to C17 as the minimum required C standard
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>
2025-11-20 09:04:46 -05:00
Martin Lampacher
dece6f91e6 doc: ztest: add a note about host restrictions for unit testing
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>
2025-11-18 11:24:17 +01:00
Matjaz Kajba
30bd32969b doc: replace getting started guide image
Replace blinky animation in getting started guide with nicer image.

Signed-off-by: Matjaz Kajba <matjaz@irnas.eu>
2025-11-17 09:22:28 -05:00
Etienne Carriere
c56dbff4fd doc: develop: flash_debug: info on OpenOCD deprecation of ST-Link HLA
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>
2025-11-15 11:26:49 +01:00
Grzegorz Chwierut
9953f330cc doc: twister: Document extra serial port
Update documentation for using multiple serial ports
with Twister's --devise-serial option.

Signed-off-by: Grzegorz Chwierut <grzegorz.chwierut@nordicsemi.no>
2025-11-13 20:42:31 -05:00
Abderrahmane JARMOUNI
12f5e5bd0e doc: develop: twister: fix titles underline inconsistency
Fix underline inconsistency of titles of level 4 by replacing + with -.

Signed-off-by: Abderrahmane JARMOUNI <git@jarmouni.me>
2025-11-06 16:25:44 -05:00
Abderrahmane JARMOUNI
5679689f90 doc: develop: test: twister: fix doc titles level issue
fix doc titles level issue reported in CI

Signed-off-by: Abderrahmane JARMOUNI <git@jarmouni.me>
2025-11-06 15:49:28 +02:00
Abderrahmane JARMOUNI
acb1071b4e doc: test: twister: document DT filtering expressions
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>
2025-11-06 15:49:28 +02:00
Benjamin Cabé
cac77c31be doc: releases: add Zephyr 4.3 release highlights
Complete the section about major highlights for Zephyr 4.3.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-11-05 15:32:21 -05:00
Benjamin Cabé
1e8a5f7dd0 doc: twister: add/move doc for display harness
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>
2025-10-31 10:36:57 -04:00
Filip Kokosinski
440b0c0915 doc/develop/manifest/external: add Zephelin
Add Zephelin [1], a Zephyr Profiling Library as an external module of the
Zephyr Project.

1: https://github.com/antmicro/zephelin

Signed-off-by: Filip Kokosinski <fkokosinski@antmicro.com>
2025-10-29 20:19:27 +02:00
Zackery Backman
6edfdb99f4 doc: develop: manifests: external: add wolfSSL
Add documentation to external module section for adding wolfSSL to Zephyr

Signed-off-by: Zackery Backman <backman23@live.com>
2025-10-28 20:20:29 -04:00
Aymeric Aillet
b4556ea923 doc: update SDK supported architectures
Architecture list comes directly from SDK readme
This list is accurate since SDK 0.17.1

Signed-off-by: Aymeric Aillet <aymeric.aillet@iot.bzh>
2025-10-24 13:29:15 -04:00
Aymeric Aillet
ea1f394b22 doc: centralizes doc for installing SDK for Linux
- rename ubuntu to linux for sdk install
- redirect duplication to linux sdk install guide

Signed-off-by: Aymeric Aillet <aymeric.aillet@iot.bzh>
2025-10-24 13:29:15 -04:00
Thorsten Klein
03a58604d7 doc: develop: west: config option build.dir-fmt
new format arguments for config option build.dir-fmt are documented
accordingly.

Signed-off-by: Thorsten Klein <thorsten.klein@bshg.com>
2025-10-24 13:26:37 -04:00
Luca Burelli
338a8b1e48 west: bindesc: add extract subcommand
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>
2025-10-24 09:43:40 +03:00
Pieter De Gendt
5f5e328a2c doc: develop: gsg: Update windows installation steps
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>
2025-10-22 18:11:45 -04:00
Declan Snyder
de6b5dba60 scripts: flash: Add west config for flash skip rebuild
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>
2025-10-20 11:22:52 -04:00
Daniel Skinstad Drabitzius
5bf4af9b72 doc: develop: manifests: external: add mender-mcu
Introduce documentation for using mender-mcu as an external module in
Zephyr.

Signed-off-by: Daniel Skinstad Drabitzius <daniel.drabitzius@northern.tech>
2025-10-07 17:44:09 +03:00
Stefan Schmidt
69548c6d94 documentation: unit tests: extend description
Add a more detailed description on how to unit test using ztest and twister


Signed-off-by: Stefan Schmidt <kontakt@stefanschmidt-embedded.de>
2025-10-05 20:02:22 -04:00
Felipe Torrezan
74380310de cmake: sca: iar: Add IAR C-STAT
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>
2025-09-29 12:37:25 -04:00
Pieter De Gendt
9b24a80faa doc: develop: west: config: Add auto-cache
Add an entry to the west configuration table for auto-cache.

Signed-off-by: Pieter De Gendt <pieter.degendt@basalte.be>
2025-09-25 14:18:25 -04:00
Pieter De Gendt
0af7142f87 doc: develop: west: Add v1.5.0 release notes
Add a section to the west release notes for v1.5.0.

Signed-off-by: Pieter De Gendt <pieter.degendt@basalte.be>
2025-09-25 14:18:25 -04:00
Jilay Pandya
90286fca85 doc: flash_debug: add macOS tab for LinkServer
Add default path for LinkServer in macOS

Signed-off-by: Jilay Pandya <jilay.pandya@outlook.com>
2025-09-24 15:49:48 +01:00
Benjamin Cabé
d87c98978c doc: west: drop "Moving to West" doc page
Converting a "pre-west" Zephyr setup is not something we officially
support anymore so drop associated documentation.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-09-22 17:52:27 -04:00
Benjamin Cabé
2308dc1f8f doc: west: remove old west 0.6 and 0.7 related troubleshooting entries
west 0.6.0 and 0.7.0 were released in 2019 and 2020 ; keeping
troubleshooting information for these versions is not needed anymore
(there isn't even a currently maintained LTS that would remotely be
concerned by this).

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-09-22 17:52:11 -04:00
Sheeba Babu
71f6840a1b doc: clarify gcc-multilib instructions for AArch64
Changed 'remove' to 'omit' to clarify package instructions for
AArch64 systems. This improves clarity for users following the
Zephyr SDK setup guide.

Signed-off-by: Sheeba Babu <sheebakarickom@gmail.com>
2025-09-21 20:52:47 -07:00
Benjamin Cabé
635e7c7261 sca: add DT diagnostic tool
implemented as an SCA for now but might benefit from being baked into
the build system so that it's always available.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-09-18 15:42:42 +01:00
Grzegorz Chwierut
bf2378e36b twister: scripts: sharing of built applications
This feature enables sharing of built applications between test
scenarios, allowing tests to access build artifacts from other
applications.

Signed-off-by: Grzegorz Chwierut <grzegorz.chwierut@nordicsemi.no>
2025-09-15 10:29:40 +02:00
Kesavan Yogeswaran
493ce8efa6 cmake: Merge extra Zephyr modules from multiple sources
Extra Zephyr modules can be provided via the EXTRA_ZEPHYR_MODULES CMake
list variable. Previously, if this variable were set in multiple places
(e.g. local CMake variable, cache variable set via -D, environment
variable), Zephyr will pick one source based on zephyr_get's documented
hierarchy and ignore the others.

Add the MERGE keyword when EXTRA_ZEPHYR_MODULES is read so that the list
of Zephyr modules is merged from all sources if this variable is set in
multiple places.

An example where this can be useful is when integrating additional Zephyr
modules with a vendor's Zephyr-based application whose build system already
contains usage of EXTRA_ZEPHYR_MODULES.

Signed-off-by: Kesavan Yogeswaran <hikes@google.com>
2025-09-10 22:38:41 -04:00
Benjamin Cabé
6de7702910 boards: doc: native_sim: adopt zephyr-board directive
Update documentation of native_sim to leverage zephyr-board Shinx magic,
in particular the ability to generate the table of supported HW
features.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-09-09 10:12:00 -04:00
Marc Herbert
8ad23f8313 twister: add space in custom_flash_scripts example and test
This makes sure parsers don't trip over whitespace (as many do).

I suggested this late in #93944

Signed-off-by: Marc Herbert <marc.herbert@intel.com>
2025-09-05 17:11:51 +02:00
Marc Herbert
2b24a495f1 doc: twister: fix argument order in custom flash example
Fixes sample command added to the documentation by commit
a31f784e95 ("twister: add a --flash-command flag")

During the review of #93944, I recommended to change the order and pass
user --flag(s) last. This was changed in the code but not in the example
added to the documentation.

Signed-off-by: Marc Herbert <marc.herbert@intel.com>
2025-09-05 17:11:51 +02:00
Noah Pendleton
6169269da8 west: blobs: fetch --allow-regex filter
When building in CI for specific SOCs, it's useful to only have `west blobs
fetch` pull a selected set of blob objects. This is especially helpful on
`hal_espressif`, which currently has 78 blob objects.

Add a `--allow-regex` arg to the `west blobs fetch` subcommand to filter
only specified blobs, for example:

```bash
# only download esp32 blobs, skip the other variants
❯ west blobs fetch hal_espressif --allow-regex 'lib/esp32/.*'
```

Also, replace all `str.format()` invocations with f-strings per review
feedback.

Signed-off-by: Noah Pendleton <noah.pendleton@gmail.com>
2025-09-04 16:44:52 +02:00
Pieter De Gendt
8d61b3633a doc: develop: optimizations: tools: Add ram_plot/rom_plot targets
Add information about the ram_plot and rom_plot build targets to generate
memory usage reports using sunburst charts.

Signed-off-by: Pieter De Gendt <pieter.degendt@basalte.be>
2025-09-04 14:42:52 +02:00
David Schneider
9a55545fd2 doc: update SDK compatibilty URL
Zephyr Version Compatibility page get moved in sdk-ng project. This
patch updates to URL to match the new page name.

Signed-off-by: David Schneider <schneidav81@gmail.com>
2025-09-04 11:26:08 +02:00
Fabio Baltieri
a31f784e95 twister: add a --flash-command flag
Currently twister requires west to flash a board, either directly using
west-flash or indirectly through the cmake flash target.

Add an option to specify a custom flash script, this is passed a
build-dir and board-id flags so it can be used to implement custom
flashing scripts in a system that does not use west.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2025-09-03 06:10:37 +02:00
Henrik Brix Andersen
8a29bfad2f doc: develop: west: alias: add example for auto-excluding platforms
Add an example west alias for automatically excluding certain platforms
when running Twister via west.

This is especially useful for excluding the 32-bit native_sim target when
running on hosts systems without a 32-bit host C library
(i.e. Linux/AArch64).

Signed-off-by: Henrik Brix Andersen <henrik@brixandersen.dk>
2025-09-03 01:16:50 +02:00
Anas Nashif
d175b5005d twister: tests: resolve warning about function being uncallable
Get rid of warnings about uncallable functions due to variable names
having test prefix.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2025-08-30 18:00:09 +01:00
Johann Fischer
617b71bc17 doc: update pyOCD repository links
The repository has been moved to a new organization, see
https://pyocd.io/. Update links to the pyOCD repository.

Signed-off-by: Johann Fischer <johann.fischer@nordicsemi.no>
2025-08-24 20:04:29 +02:00
Yasushi SHOJI
8f7700be19 doc: getting_started: simplify Python dependency install step
The original wording made the `west packages` step look optional, which
caused confusion for users. Rephrase it as a direct instruction to make it
clear this step is required.

ref: https://github.com/zephyrproject-rtos/zephyr/discussions/94572

Signed-off-by: Yasushi SHOJI <yashi@spacecubics.com>
2025-08-20 02:18:12 +02:00
Ha Duong Quang
7e1146fe9d doc: flash_debug: add requirement for debug probe supported
Document the S32DS and S32Debug Probe OS supported version,
and guide to upgrade the OS of the S32DebugProbe.

Signed-off-by: Ha Duong Quang <ha.duongquang@nxp.com>
2025-08-18 13:07:32 +02:00