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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
Only HTML builds actually display board documentation so there is no
point in generating the list of hardware features in other builds.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Advertise the newly-introduced header file as it's meant
to be used by subsystem and application developers.
Signed-off-by: Tomi Fontanilles <tomi.fontanilles@nordicsemi.no>
This resolves some addressed comments in this PR zephyrproject-rtos#77930
as well as this PR zephyrproject-rtos#80407
Signed-off-by: Riadh Ghaddab <rghaddab@baylibre.com>
Introduce a new directive for displaying hardware features supported by
a board, using information available in the devicetree.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Add back a reference to EOL'd LTS releases, in a structured way, just
the name, a link to the documentation and the EOL date.
Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
Add a new hardware features filter to the board catalog that allows
users to filter boards based on their supported hardware capabilities.
The features are extracted from the devicetree files and organized by
binding type.
Key changes:
- Extract hardware feature descriptions from devicetree bindings
- Add HW_FEATURES_TURBO_MODE option to skip feature generation for
faster builds (similar to DT_TURBO_MODE)
- Add tag-based UI for filtering boards by hardware features
The feature can be disabled for faster documentation builds using
-DHW_FEATURES_TURBO_MODE=1 or by using 'make html-fast'.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This is a follow-up from a recent debate on Discord about whether
splitting up related groups of properties is OK. Record the consensus
outcome of the debate so this question is easier to answer next time.
Signed-off-by: Martí Bolívar <marti.bolivar@oss.qualcomm.com>
Sphinx documents should not appear in multiple toctrees.
Consolidate SMP Groups under SMP Protocol Specification.
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
