Commit Graph

6724 Commits

Author SHA1 Message Date
TOKITA Hiroshi 700910edfc doc: release: 3.7: Remove the duplicated colon.
Beautify the line about the support of the Arduino UNO R4 WiFi board.

Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>
2024-07-01 09:03:37 -04:00
TOKITA Hiroshi e0f148fdb9 doc: release: 3.7: Release notes for Renesas EK-RA8M1 board
Add Renesas EK-RA8M1 board that is supported in release 3.7

Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>
2024-07-01 09:03:37 -04:00
Benjamin Cabé 6e4a45f7a9 doc: css: Use body color for captions
Make sure that captions (tables, figures, ...) can be properly
seen on both light and dark them by setting their text color
to the default "body" color.
Fixes #73190.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-07-01 09:02:54 -04:00
Carles Cufi 457994816b doc: west: Clarify basic west terms
Terms like the west workspace or even west projects and modules were not
documented prominently enough, prompting users to ask for additional
clarification. This patch attempts to resolve this by adding terms and
explanation of concepts to the glossary and west doc pages.

Fixes #67376.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2024-06-28 12:22:41 -04:00
Emil Gydesen cb80ca3a50 doc: Bluetooth: Add sample app for CAP ini/acc in status table
Add the sample application as existing for the CAP initiator
and CAP acceptor.

The samples are still in progress of being improved and
fully featured, but they exist and can be used already now.

Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
2024-06-28 12:21:37 -04:00
Jukka Rissanen 2abd982040 doc: release-notes-3.7: Add notes for selected network components
Added release notes for these network components:

* DNS/mDNS/LLMNR
* gPTP/PTP
* Sockets
* Capture API
* Virtual interface
* VLAN
* Wi-Fi

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
2024-06-28 12:21:05 -04:00
Jordan Yates 5b0fb6e406 doc: release-notes: document CMSIS-NN upgrade
Update the version update and link to the changelog.

Signed-off-by: Jordan Yates <jordan@embeint.com>
2024-06-28 07:50:12 -04:00
Dominik Ermel f0d443e3d1 doc: release: 3.7: Add release notes for Flash
Flash API additions and new drivers.

Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
2024-06-28 07:19:59 -04:00
Dominik Ermel 568ccd585a doc: release: 3.7: Add Flash Map release notes
Add notes on changes in Flash Map.

Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
2024-06-28 07:19:39 -04:00
Emil Gydesen 6af17919d6 doc: releases: migration-guide-3.7: Add not for BT_LE_ADV_PARAM
The macro was modified in a way that may cause issues for some.
See e.g. 15d66ccc23
for an example of it needing a change.

The migration guide GH PR number refers to the PR that modified
the macro.

Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
2024-06-28 11:35:56 +02:00
Andrej Butok b93453fe56 doc: release: 3.7: Add note about LinkServer runner .hex support
Added note about enabled flash support for Intel Hex
files for the LinkServer runner.

Signed-off-by: Andrej Butok <andrey.butok@nxp.com>
2024-06-27 18:02:57 -04:00
Robert Lubos fcb23000e9 doc: release-notes: Add 3.7.0 release notes for networking
Add 3.7.0 release notes for networking.

Signed-off-by: Robert Lubos <robert.lubos@nordicsemi.no>
2024-06-27 18:02:25 -04:00
Chris Friedt e9b676a9ab doc: posix: mark posis fd mgmt as supported
Mark the POSIX_FD_MGMT Option Group as supported.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
2024-06-27 15:17:56 -04:00
Chris Friedt b10f1ca3a6 doc: posix: mark posix signals supported with undefined behaviour
Mark the POSIX_SIGNALS Option Group as supported to the extent
possible under Zephyr, as Zephyr does not yet support processes.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
2024-06-27 15:16:50 -04:00
Anas Nashif 10c9037ff1 doc: release: allow tests after RC1
After RC1 (feature freeze), new tests for existing features are allowed.
Afterwards, only bug fixes and documentation to existing tests are
allowed.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2024-06-27 15:15:43 -04:00
Anas Nashif ef5bb33f7b doc: Update release criteria
Update release criteria based on previous discussions and agreements
reached.
- remove bug count at critria
- Add platform tiers
- Define criteria
- Clarify block bugs

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2024-06-27 15:15:43 -04:00
Anas Nashif 1706879fbd doc: release: clarify changes allowed during stabilization
Clarificatin on feature freeze and exceptions.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2024-06-27 15:15:43 -04:00
Adrien Ricciardi 914d7911da doc: storage: nvs: Fixed data CRC notes formatting
Used the same notes format than in other parts of the documentation.

Signed-off-by: Adrien Ricciardi <aricciardi@baylibre.com>
2024-06-27 15:15:08 -04:00
Chris Friedt d9855da483 doc: posix: mark posix device io as complete
Mark the POSIX_DEVICE_IO Option Group as commplete. This Option
Group is required for PSE51, PSE52, PSE53, PSE54, and most of
the interesting applications involving file descriptors and
sockets.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
2024-06-27 09:01:23 -04:00
Alberto Escolar Piedras ad3dcc9f89 doc: release 3.7: Add bsim related notes
Mention that coded phy is now supported and tested

Signed-off-by: Alberto Escolar Piedras <alberto.escolar.piedras@nordicsemi.no>
2024-06-27 08:47:11 -04:00
Declan Snyder 58c347a44c doc: release-notes-3.7: Add reset drivers notes
Add release notes for the reset controller driver class.

Signed-off-by: Declan Snyder <declan.snyder@nxp.com>
2024-06-27 08:50:01 +02:00
Dominik Ermel c51e22c97e doc: release: 3.7: Fix typos
Some typos fixes.

Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
2024-06-27 08:28:02 +02:00
Henrik Brix Andersen f4dbe524d0 doc: releases: release notes: 3.7: add remaining CAN release notes
Add remaining Controller Area Network (CAN) subsystem release notes for
v3.7.0.

Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
2024-06-26 13:05:59 -04:00
Henrik Brix Andersen bc88a81c0a doc: releases: release notes: 3.7: add EEPROM release notes
Add EEPROM subsystem release notes for v3.7.0.

Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
2024-06-26 13:05:25 -04:00
Simon Frank 2ca7e41b26 drivers/sensor: lis2mdl: use common SPI duplex option
Driver used a custom SPI duplex option. Replaced with the common one
found in spi-device.yaml.

Signed-off-by: Simon Frank <simon.frank@lohmega.com>
2024-06-26 09:01:13 -04:00
Jamie McCrae b325f50599 doc: release: 3.7: Add note on build system watch file fix
Adds a note that an issue with watched files has been fixed

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2024-06-26 08:59:24 -04:00
Chris Friedt 9ada52f060 fdtable: replace z_ prefix with zvfs_ for fdtable.h functions
For each of the fdtable.h functions listed below, convert the
z_ prefixed semi-private functions to use the zvfs_ prefix.

ZVFS stands for Zephyr Virtual File System and
is intended to be a common library used by the C library,
POSIX API, Networking, Filesystem, and other areas.

There are already a few functions in fdtable.h that use the
zvfs_ prefix, so this change is mostly about unifying them in
a way that uses a suitable prefix ("namespace") so that it can
be considered a public API.

- z_alloc_fd
- z_fdtable_call_ioctl
- z_finalize_fd
- z_finalize_typed_fd
- z_free_fd
- z_get_fd_obj
- z_get_fd_obj_and_vtable
- z_get_obj_lock_and_cond
- z_reserve_fd

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
2024-06-26 12:33:02 +02:00
Fabian Blatz f95f57c668 doc: release: 3.7: Add note on LVGL changes
Adds release notes for the LVGL Zephyr module.

Signed-off-by: Fabian Blatz <fabianblatz@gmail.com>
2024-06-26 05:58:24 -04:00
Johann Fischer 90081578ae doc: mm: fix heap function references in documentation
Add missing doxygengroup Low Level Heap Allocator and Multi-Heap Wrapper
Utility.

Signed-off-by: Johann Fischer <johann.fischer@nordicsemi.no>
2024-06-25 21:26:55 -04:00
Fabio Baltieri 766de73e08 doc: release: 3.7: add input release notes
Just few new drivers and two migrated ones.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2024-06-25 19:13:41 -04:00
Andrej Butok 1c8dd59187 doc: modem: fix double from
Fix the double 'from' in the "Modem pipelink" chapter.

Signed-off-by: Andrej Butok <andrey.butok@nxp.com>
2024-06-25 12:18:15 -04:00
Enguerrand de Ribaucourt dc987267ac doc: develop: tools: add VS Code setup guide
This basic guide only covers linting so far. It could be expanded in the
future to be more accurate and detailed. The current configuration
allows to navigate the code but some symbols are not recognized by the
linter, and the native compiler is always used.

Co-authored-by: Enguerrand de Ribaucourt <enguerrand.de-ribaucourt@savoirfairelinux.com>
Co-authored-by: Luc BEAUFILS <luc.beaufils@savoirfairelinux.com>
Signed-off-by: Enguerrand de Ribaucourt <enguerrand.de-ribaucourt@savoirfairelinux.com>
Signed-off-by: Luc BEAUFILS <luc.beaufils@savoirfairelinux.com>
2024-06-25 10:26:55 -04:00
Anas Nashif e0f8a8f16e twister: remove some of the confusion in terminology
Remove legacy use of 'test case' and replace with `test scenario` where
applicable.
Update terminology and some other parts of twister docs.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2024-06-25 10:25:51 -04:00
Anas Nashif 6829210775 doc: ztest: Fix confusing terminology and align with twister.
Testcase definition to match what we use in twister.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2024-06-25 10:25:51 -04:00
Grzegorz Swiderski 282f728752 doc: board_porting: Fix Kconfig.defconfig example
The part that says "Always set CONFIG_BOARD here" is outdated. In HWMv2,
CONFIG_BOARD is set by the build system, and we don't want to encourage
users to set it manually.

Signed-off-by: Grzegorz Swiderski <grzegorz.swiderski@nordicsemi.no>
2024-06-25 06:07:21 -04:00
Lingao Meng 302422ad9d everywhere: replace double words
import os
import re

common_words = set([
    'about', 'after', 'all', 'also', 'an', 'and',
     'any', 'are', 'as', 'at',
    'be', 'because', 'but', 'by', 'can', 'come',
    'could', 'day', 'do', 'even',
    'first', 'for', 'get', 'give', 'go', 'has',
    'have', 'he', 'her',
    'him', 'his', 'how', 'I', 'in', 'into', 'it',
    'its', 'just',
    'know', 'like', 'look', 'make', 'man', 'many',
    'me', 'more', 'my', 'new',
    'no', 'not', 'now', 'of', 'one', 'only', 'or',
    'other', 'our', 'out',
    'over', 'people', 'say', 'see', 'she', 'so',
    'some', 'take', 'tell', 'than',
    'their', 'them', 'then', 'there', 'these',
    'they', 'think',
    'this', 'time', 'two', 'up', 'use', 'very',
    'want', 'was', 'way',
    'we', 'well', 'what', 'when', 'which', 'who',
    'will', 'with', 'would',
    'year', 'you', 'your'
])

valid_extensions = set([
    'c', 'h', 'yaml', 'cmake', 'conf', 'txt', 'overlay',
    'rst', 'dtsi',
    'Kconfig', 'dts', 'defconfig', 'yml', 'ld', 'sh', 'py',
    'soc', 'cfg'
])

def filter_repeated_words(text):
    # Split the text into lines
    lines = text.split('\n')

    # Combine lines into a single string with unique separator
    combined_text = '/*sep*/'.join(lines)

    # Replace repeated words within a line
    def replace_within_line(match):
        return match.group(1)

    # Regex for matching repeated words within a line
    within_line_pattern =
	re.compile(r'\b(' +
		'|'.join(map(re.escape, common_words)) +
		r')\b\s+\b\1\b')
    combined_text = within_line_pattern.
		sub(replace_within_line, combined_text)

    # Replace repeated words across line boundaries
    def replace_across_lines(match):
        return match.group(1) + match.group(2)

    # Regex for matching repeated words across line boundaries
    across_lines_pattern = re.
		compile(r'\b(' + '|'.join(
			map(re.escape, common_words)) +
			r')\b(\s*[*\/\n\s]*)\b\1\b')
    combined_text = across_lines_pattern.
		sub(replace_across_lines, combined_text)

    # Split the text back into lines
    filtered_text = combined_text.split('/*sep*/')

    return '\n'.join(filtered_text)

def process_file(file_path):
    with open(file_path, 'r', encoding='utf-8') as file:
        text = file.read()

    new_text = filter_repeated_words(text)

    with open(file_path, 'w', encoding='utf-8') as file:
        file.write(new_text)

def process_directory(directory_path):
    for root, dirs, files in os.walk(directory_path):
        dirs[:] = [d for d in dirs if not d.startswith('.')]
        for file in files:
            # Filter out hidden files
            if file.startswith('.'):
                continue
            file_extension = file.split('.')[-1]
            if
	file_extension in valid_extensions:  # 只处理指定后缀的文件
                file_path = os.path.join(root, file)
                print(f"Processed file: {file_path}")
                process_file(file_path)

directory_to_process = "/home/mi/works/github/zephyrproject/zephyr"
process_directory(directory_to_process)

Signed-off-by: Lingao Meng <menglingao@xiaomi.com>
2024-06-25 06:05:35 -04:00
Jamie McCrae 28eb135391 doc: release: 3.7: Add note on build system changes
Adds release notes for self submitted build system changes

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2024-06-24 22:31:12 -04:00
Jamie McCrae 5f2a2d6e22 doc: release: 3.7: Add note on MCUboot changes
Adds release notes for MCUboot

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2024-06-24 22:31:12 -04:00
Martin Jäger 7bc2806b2c doc: release-notes v3.7: add LoRaWAN section
Inform about newly added support for LoRaWAN fragmented transport and
firmware-upgrade over the air (FUOTA).

Signed-off-by: Martin Jäger <martin@libre.solar>
2024-06-24 22:28:55 -04:00
Flavio Ceolin ba126b36ea doc: vuln: Add CVE under embargo
Add an entry to CVE-2024-6258

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-06-24 22:26:11 -04:00
Flavio Ceolin bf70a80a81 doc: vuln: Add CVE under embargo
Add an entry to CVE-2024-6259

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-06-24 22:26:11 -04:00
Carles Cufi a87b825641 doc: bluetooth: mesh: Remove outdated text
The bt_mesh_cfg_srv structure was removed in ad2fd44d7a, no need to
keep this text here anymore.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2024-06-24 12:42:30 -04:00
Andrej Butok 5310ee7bf4 doc: mem_mgmt: fix mem_non_cacheable code
Fix the mem_non_cacheable code according its comment.

Signed-off-by: Andrej Butok <andrey.butok@nxp.com>
2024-06-24 12:40:19 -04:00
Jordan Yates a9456221cd doc: version: document the numeric version limits
The `VERSION` numeric fields are used to construct the `uint32_t`
`KERNELVERSION` and `APPVERSION` values, which only allocates a single
byte for each field.

The field in `app_version.h` is `APP_TWEAK`, not `APP_VERSION_TWEAK`.

Signed-off-by: Jordan Yates <jordan@embeint.com>
2024-06-24 08:28:54 -04:00
Jordan Yates 07870934e3 everywhere: replace double words
Treewide search and replace on a range of double word combinations:
    * `the the`
    * `to to`
    * `if if`
    * `that that`
    * `on on`
    * `is is`
    * `from from`

Signed-off-by: Jordan Yates <jordan@embeint.com>
2024-06-22 05:40:22 -04:00
Peter Mitsis 11417b2b57 doc: kernel: smp: Add section about IPI cascades
Adds a section providing additional information about IPI cascades
to the kernel's SMP documentation.

Signed-off-by: Peter Mitsis <peter.mitsis@intel.com>
2024-06-21 20:49:11 -04:00
Bjarki Arge Andreasen 3d67591971 doc: relase: Document addition of at shell and pipelinks
Document the addition of pipelinks to the modem_cellular.c device
driver and the new modem at shell which uses the pipelinks to
communicate directly with the modems.

Signed-off-by: Bjarki Arge Andreasen <bjarki@arge-andreasen.me>
2024-06-21 15:25:48 -04:00
Bjarki Arge Andreasen 99866e172a doc: release notes: Added release notes for modem subsystem
Added release notes for modem subsystem for release 3.7

Signed-off-by: Bjarki Arge Andreasen <bjarki@arge-andreasen.me>
2024-06-21 15:25:48 -04:00
Bjarki Arge Andreasen 49e3910f41 doc: services: modem: add section for pipelink
Add section documenting the new modem pipelink.

Signed-off-by: Bjarki Arge Andreasen <bjarki@arge-andreasen.me>
2024-06-21 15:25:48 -04:00
Carles Cufi caa25827a7 doc: soc porting: Fix introduction paragraph
The introductory paragraph had a broken link and was arbitrarily
referencing a couple of files that will be described extensively later.
Instead, just present the content generically.

Fixes #69990.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2024-06-21 14:57:30 -04:00