Commit graph

4531 commits

Author SHA1 Message Date
Fabio Baltieri fa51b3db1c doc: release process: only use the overview for the release page
Change the release process documentation to only use the overview of the
release notes for GitHub releases rather than the full file.

The current instructions of copying the full content are broken (the
file does not fit anyway and the formatting is incompatible) and result
in a cluttered page anyway (the UI is not really meant for long release
notes).

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2022-10-07 14:32:42 +02:00
Jamie McCrae a65fe8bc6a doc: release: 3.3: Add deprecated mcumgr Kconfig release note
Adds a release note about deprecated mcumgr Kconfig removal.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2022-10-06 16:34:58 +02:00
Jamie McCrae 100e0cf92f doc: mcumgr: Remove deprecated Kconfig tip
Removes a tip about using an old removed Kconfig value.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2022-10-06 16:34:58 +02:00
Cong Nguyen Huu 708fee8f61 doc: develop: test: update twister guide
add run steps guide for windows

Signed-off-by: Cong Nguyen Huu <cong.nguyenhuu@nxp.com>
2022-10-06 07:23:17 -04:00
Juha Heiskanen 1e7e17de72 doc: lwm2m: Time series data document update
Added documentation for Time series data.

Signed-off-by: Juha Heiskanen <juha.heiskanen@nordicsemi.no>
2022-10-05 14:23:32 +00:00
Daniel DeGrasse 50c7341070 doc: test: add documentation for twister sysbuild flag
Add sysbuild flag to twister supported options, with documentation on
how Kconfig and devicetree will be parsed

Signed-off-by: Daniel DeGrasse <daniel.degrasse@nxp.com>
2022-10-04 14:06:58 -04:00
Anders Storrø b9f776d2fb Bluetooth: Mesh: Shell: Clear CDB on local reset
Adds feature that clears the CDB entry on local reset.

Signed-off-by: Anders Storrø <anders.storro@nordicsemi.no>
2022-10-04 10:20:38 +00:00
Jamie McCrae cf3b10a2c0 doc: release: 3.3: Add working release notes file
Adds a base working release notes file for the Zephyr 3.3 release.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2022-10-04 11:21:23 +02:00
Tomasz Moń 800ec14cd3 doc: polling: Fix semaphore contested description
If a semaphore is contested, it is possible that the semaphore will no
longer be available when k_sem_take() is called, not k_sem_give().

Fix few typos and explicitly mention poll events instead of "they".

Signed-off-by: Tomasz Moń <tomasz.mon@nordicsemi.no>
2022-10-04 10:36:45 +02:00
Anders Storrø bea54c5691 Bluetooth: Mesh: Shell: Make prov features dynamic
Alters several provisioning related features to allow commands to be
functional with application defined Provisioning properties &
capabilities.

Signed-off-by: Anders Storrø <anders.storro@nordicsemi.no>
2022-10-04 10:33:30 +02:00
Juha Heiskanen 8279489aee net: lwm2m: RD Client update registration timeout
Renamed LWM2M_RD_CLIENT_EVENT_REG_UPDATE_FAILURE to
LWM2M_RD_CLIENT_EVENT_REG_TIMEOUT.

Changed reported event type for registration timeout to
LWM2M_RD_CLIENT_EVENT_REG_TIMEOUT from
LWM2M_RD_CLIENT_EVENT_REGISTRATION_FAILURE.
LWM2M_RD_CLIENT_EVENT_REGISTRATION_FAILURE should be only
reported case when server reject by response registration.

Signed-off-by: Juha Heiskanen <juha.heiskanen@nordicsemi.no>
2022-10-03 10:20:13 +02:00
Erwan Gouriou bd6a25a661 doc: porting: shields: Provide guidelines for nodelabel
In order to avoid device definitions conflicts when compiling shields
description with boards embedding similar devices, nodelabels of devices
in shield's devicetree file should differ from the nodelabels used in
board's devicetree file.
The form to be used was discussed in #50040 and agreed to be as
<device>_<shield_name>.

Update shields documentation to make it an explicit rule.

Signed-off-by: Erwan Gouriou <erwan.gouriou@linaro.org>
2022-10-03 10:16:57 +02:00
Erwan Gouriou 656382e7a4 doc: porting: shields: Update instructions for nodelabel definitions
Update requirements regarding board connectors compatibility now that
dtc versions prior to 1.4.2 can't be used anymore (current required
version is 1.4.6).

Signed-off-by: Erwan Gouriou <erwan.gouriou@linaro.org>
2022-10-03 10:16:57 +02:00
Gerard Marull-Paretas fdea3c9a44 devicetree: add DT(_INST)_FOREACH_PROP_ELEM_SEP(_VARGS)
Add a new set of helpers for expanding property entries with a
separator. These macros complement DT(_INST)FOREACH_PROP_ELEM(_VARGS) by
adding the capability to expand with a custom separator between property
entries. This allows, in some cases, to re-use existing macros (e.g.
DT_PROP_BY_IDX) without creating an auxiliary macro that just appends a
separator. Example:

```dts
n: node {
	...
	my-gpios = <&gpioa 0 GPIO_ACTIVE_HIGH>,
		   <&gpiob 1 GPIO_ACTIVE_HIGH>;
};
```

Before:

```c
 #define GPIO_DT_SPEC_BY_IDX_AND_COMMA(node_id, prop, idx) \
	GPIO_DT_SPEC_BY_IDX(node_id, prop, idx),

struct gpio_dt_spec specs[] = {
	DT_FOREACH_PROP_ELEM(DT_NODELABEL(n), my_gpios,
			     GPIO_DT_SPEC_BY_IDX_AND_COMMA)
};
```

After:

```c
struct gpio_dt_spec specs[] = {
	DT_FOREACH_PROP_ELEM_SEP(DT_NODELABEL(n), my_gpios,
				 GPIO_DT_SPEC_BY_IDX, (,))
};
```

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-10-03 10:11:18 +02:00
Gerard Marull-Paretas 1f98c24fc2 doc: dts: macros.bnf: add missing DT_FOREACH_PROP_ELEM entries
Entries for DT_FOREACH_PROP_ELEM_(VARGS) internal helpers were missing.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-10-03 10:11:18 +02:00
Fabio Baltieri 896935066b doc: conf: add release version 3.2.0
Add release version 3.2.0 to the documentation version list.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2022-09-30 11:31:32 -05:00
Fabio Baltieri 3224a50e03 doc: release: remove "Working Draft" from 3.2 release notes title
Drop the "Working Draft" note from the 3.2 release note document title.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2022-09-30 11:31:32 -05:00
Fabio Baltieri d8c5f8f33c doc: release: add a bunch of missing "."
Add few missing "." to list entries, the ones that looks like sentences
anyway.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2022-09-30 11:31:32 -05:00
Fabio Baltieri 3344f16dd5 doc: release: drop empty sections
Drop empty sections from the 3.2 release notes file.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2022-09-30 11:31:32 -05:00
Fabio Baltieri 37605482d7 doc: release: various cleanups for 3.2
Various manual cleanups for the 3.2 release notes: spelling, wrong
bindings, tags...

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2022-09-30 11:31:32 -05:00
Fabio Baltieri a8590d8f1b doc: release: drop few non relevant entries from the issue list
Drop issues related to backports and other ones that do not seem
relevant to the release.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2022-09-30 11:31:32 -05:00
Fabio Baltieri 1f876ae04c doc: releases: known issues for v3.2.0
Add the list of open issues after the last triage:

wget https://builds.zephyrproject.io/zephyr/bug-snapshot/zephyr-bugs-2022-09-30.pickle.xz
unxz zephyr-bugs-2022-09-30.pickle.xz
./scripts/dump_bugs_pickle.py zephyr-bugs-2022-09-30.pickle

Manually fixed few doc generation warnings.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2022-09-30 11:31:32 -05:00
Fabio Baltieri a1a35b47cf doc: releases: resolved issues for v3.2.0
Adding the list of closed bugs since v3.1.0:

./scripts/release/list_issues.py -o zephyrproject-rtos -r zephyr -s
  2022-06-05 -f issues.txt

And some manual fixup to make doxygen happy.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2022-09-30 11:31:32 -05:00
Andrzej Puzdrowski f59188f989 doc/release-note-3.2: storage changelog
Summary on storage updates for 3.2 release.

Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
2022-09-30 14:46:17 +00:00
Fabio Baltieri 63ead2bf67 doc: release: add overview section
Add (back) an overview section to the release notes, mentioning few
improvements in this release.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2022-09-30 16:05:41 +02:00
Andrzej Puzdrowski 4462f6b4b6 doc/release-note-3.2: DFU subsystem changelog
Added summary on the DFU subsystem changes.

Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
2022-09-30 13:55:18 +00:00
Jakub Rzeszutko 02355bc2fc doc: release-notes-3.2: release notes for shell
Add release notes for the shell subsystem.

Signed-off-by: Jakub Rzeszutko <jakub.rzeszutko@nordicsemi.no>
2022-09-30 13:54:52 +00:00
Dominik Ermel bde86849fc doc/release: Add note on deprecated FLASH_MAP_ macros
Note on replacement of FLASH_MAP_ macros with FIXED_PARTITION_
macros.

Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
2022-09-30 07:44:49 -05:00
Johann Fischer de700211ff doc: release-notes-3.2: add release notes for MODBUS support
Add release notes for MODBUS support.

Signed-off-by: Johann Fischer <johann.fischer@nordicsemi.no>
2022-09-29 14:18:59 +00:00
Johann Fischer d11816af87 doc: release-notes-3.2: add release notes for display controller driver
Add release notes for display controller driver.

Signed-off-by: Johann Fischer <johann.fischer@nordicsemi.no>
2022-09-29 14:18:59 +00:00
Johann Fischer 9dceb41894 doc: release-notes-3.2: add release notes for USB support
Add release notes for USB support.

Signed-off-by: Johann Fischer <johann.fischer@nordicsemi.no>
2022-09-29 14:18:59 +00:00
Krzysztof Chruscinski 7dc87c6bf1 doc: releases: Updates for counter, clock and logging
Updated release notes with changes in the counter, clock control and
logging.

Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2022-09-29 08:55:03 -05:00
Filip Kokosinski 6b36e2f4d5 doc: release-notes: add RISC-V release notes for v3.2.0
This commit adds RISC-V release notes for Zephyr v3.2.0.

Signed-off-by: Filip Kokosinski <fkokosinski@antmicro.com>
2022-09-29 08:48:50 -05:00
Krzysztof Chruscinski 9a3d762ee2 doc: logging: Update section about log processing
'Controlling the logging' section was not clear enough. Updating it
to clarify that logging processing in deferred mode is by default
handled implicitly.

Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2022-09-29 08:26:54 -05:00
Andrzej Głąbek 2aa0642cce doc: release-notes-3.2: Add notes for ADC, I2S, PWM, and Nordic HAL
Add entries for ADC, I2S, and PWM drivers and for Nordic HAL.

Signed-off-by: Andrzej Głąbek <andrzej.glabek@nordicsemi.no>
2022-09-29 11:45:11 +00:00
Stephanos Ioannidis a041f5ce10 doc: toolchains: Update custom toolchain CMake reference file names
This commit updates the CMake reference file names for custom
toolchains.

The contents of `cmake/generic_toolchain.cmake` and
`cmake/target_toolchain.cmake` were moved
`cmake/modules/FindHostTools.cmake` and
`cmake/modules/FindTargetTools.cmake`, respectively.

Refer to the commit 8d2998d4f9 and
7131d02fa4 for more details.

Signed-off-by: Stephanos Ioannidis <stephanos.ioannidis@nordicsemi.no>
2022-09-29 12:20:14 +02:00
Stephanos Ioannidis cf400c6c63 doc: flash_debug: Update OpenOCD and pyOCD links
This commit updates the outdated links for OpenOCD and pyOCD.

Signed-off-by: Stephanos Ioannidis <stephanos.ioannidis@nordicsemi.no>
2022-09-29 12:20:14 +02:00
Stephanos Ioannidis 4cf129e13b doc: peripherals: i2c: Fix incorrect hyperlink references
This commit fixes incorrect external hyperlink references.

Signed-off-by: Stephanos Ioannidis <stephanos.ioannidis@nordicsemi.no>
2022-09-29 12:20:14 +02:00
Stephanos Ioannidis e536541f4f doc: virtualization: Update outdated link to ivshmem
This commit updates the outdated link to the QEMU ivshmem
documentation.

Signed-off-by: Stephanos Ioannidis <stephanos.ioannidis@nordicsemi.no>
2022-09-29 12:20:14 +02:00
Stephanos Ioannidis 2352f7470b doc: peripherals: tcpc: Fix incorrect hyperlink references
This commit fixes incorrect external hyperlink references.

Signed-off-by: Stephanos Ioannidis <stephanos.ioannidis@nordicsemi.no>
2022-09-29 12:20:14 +02:00
Stephanos Ioannidis d85900d0f7 doc: west: Update outdated link to SPDX specification
This commit updates the outdated link to the SPDX specification.

Signed-off-by: Stephanos Ioannidis <stephanos.ioannidis@nordicsemi.no>
2022-09-29 12:20:14 +02:00
Stephanos Ioannidis 9f5ad65446 doc: tools: coccinelle: Update documentation link
This commit updates the oudated link to the Cocinelle documentation.

Signed-off-by: Stephanos Ioannidis <stephanos.ioannidis@nordicsemi.no>
2022-09-29 12:20:14 +02:00
Stephanos Ioannidis 14d3c7338e doc: kconfig: Update outdated links to Kconfig documentation
This commit updates the outdated links to the Kconfig documentation in
the Linux kernel repository with those from the official documentation.

Signed-off-by: Stephanos Ioannidis <stephanos.ioannidis@nordicsemi.no>
2022-09-29 12:20:14 +02:00
Stephanos Ioannidis 97efbec18b doc: test: Update link to Sparse documentation
Update the Sparse documentation to refer to the official Sparse
documentation instead of some random link, which no longeer works.

It also fixes an incorrect inline literal usage.

Signed-off-by: Stephanos Ioannidis <stephanos.ioannidis@nordicsemi.no>
2022-09-29 12:20:14 +02:00
Stephanos Ioannidis dc66be5d7d doc: bluetooth: autopts: Fix internal linking
Links/references to the pages internal to the documentation should
use `:ref:`.

Signed-off-by: Stephanos Ioannidis <stephanos.ioannidis@nordicsemi.no>
2022-09-29 12:20:14 +02:00
Stephanos Ioannidis 14539ed2e8 doc: documentation: Fix incorrect doc/Makefile reference
This commit fixes the incorrect reference to the `doc/Makefile` and
updates the text to better integrate the reference.

Signed-off-by: Stephanos Ioannidis <stephanos.ioannidis@nordicsemi.no>
2022-09-29 12:20:14 +02:00
Stephanos Ioannidis 4811575616 doc: documentation: Fix internal linking description
This commit fixes incorrect depiction of the internal link with custom
text usage.

Signed-off-by: Stephanos Ioannidis <stephanos.ioannidis@nordicsemi.no>
2022-09-29 12:20:14 +02:00
Stephanos Ioannidis a811d3889b doc: documentation: Update outdated file paths
This commit updates the documentation guidelines to reflect the
refactored documentation paths.

It also corrects the unnecessary escapes of the backticks.

Signed-off-by: Stephanos Ioannidis <stephanos.ioannidis@nordicsemi.no>
2022-09-29 12:20:14 +02:00
Stephanos Ioannidis 8a7eb68c0f doc: security: Fix outdated link
This commit updates the outdated link to "OWASP Top Ten Project".

Signed-off-by: Stephanos Ioannidis <stephanos.ioannidis@nordicsemi.no>
2022-09-29 12:20:14 +02:00
Stephanos Ioannidis 45a8ace1f3 doc: Use inline literals
Use inline literals where applicable -- especially for the words that
contain `@`; otherwise, Sphinx will think it is an email address.

Signed-off-by: Stephanos Ioannidis <stephanos.ioannidis@nordicsemi.no>
2022-09-29 12:20:14 +02:00