Commit graph

3456 commits

Author SHA1 Message Date
Anas Nashif 20aa90d26c doc: move documentation guidelines
Move documentation guidelines under contribution guidelines.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2021-06-11 08:50:39 -04:00
Anas Nashif dd41aca3d3 doc: move coding guidelines under contribute/
Move coding guideline under contribution guidelines.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2021-06-11 08:50:39 -04:00
Anas Nashif a7a4a2ef2c doc: move coverage docs into test section
Coverage reports and genrally part of testing, so move it under this
existing section.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2021-06-11 08:50:39 -04:00
Ioannis Glaropoulos 45bdb186bb doc: release notes: add some entries for TF-M
Add entries for TF-M in the 2.7.0 release notes.

Signed-off-by: Ioannis Glaropoulos <Ioannis.Glaropoulos@nordicsemi.no>
2021-06-10 18:38:03 -05:00
Pavel Vasilyev 0335d5fb01 Bluetooth: Mesh: Add OOB Public Key support for provisionee role
This commit allows an unprovisioned device to exchange its public key
using out-of-band techology (see MeshPRFv1.0.1, table 5.19 and section
5.4.2.3).

For in-band public key exchange, the mesh stack uses HCI commands to
generate public and private keys, and DH key. This, however, doesn't
work for OOB public key exchange since there is no command to generate
DH key with a private key provided by an application. Therefore, this
commit adds direct usage of TinyCrypto into the mesh stack for DH key
generation for OOB public key support.

Signed-off-by: Pavel Vasilyev <pavel.vasilyev@nordicsemi.no>
2021-06-10 17:14:03 -04:00
Henrik Brix Andersen 650c760e27 doc: guides: flash_debug: coredump: remove extraneous backtick
Remove extraneous backtick from coredump documentation.

Signed-off-by: Henrik Brix Andersen <henrik@brixandersen.dk>
2021-06-10 13:17:45 -05:00
Erwan Gouriou 2ef3ebed9c doc/guides/dts: bindings: Fix code snippet for 'signal-gpios'
Code snippet to demonstrate use of 'zephyr,user' binding
for gpio pin was missing a #define to easily get the code
compiling.
Fix this.

Signed-off-by: Erwan Gouriou <erwan.gouriou@linaro.org>
2021-06-08 15:32:23 -05:00
Gerard Marull-Paretas a140a249b3 doc: only enable -W option on CI
The usage of -W may lead to the loss of the Sphinx build environment
even for small typos. Remove this option from the defaults but still
enable it on CI, where the fail-fast behavior given by -W is desired.

Fixes #36033

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2021-06-08 09:58:32 -05:00
Arvin Farahmand 98a0ccd5c5 drivers: hwinfo: Add reset cause support
Add `hwinfo_get_reset_cause` and `hwinfo_clear_reset_cause` to retrieve
and to clear cause of system reset on supported platforms.

Different platforms can provide different causes of reset, however
there is a great deal of overlap. `enum reset_cause` can be expanded in
the future to support additional reasons, as additional platforms are
supported.

Signed-off-by: Arvin Farahmand <arvinf@ip-logix.com>
2021-06-08 10:16:17 +02:00
Ioannis Glaropoulos efccfcbfc9 doc: add draft for 2.7 release notes
Add draft for the Zephyr v2.7.0 release notes.

Signed-off-by: Ioannis Glaropoulos <Ioannis.Glaropoulos@nordicsemi.no>
2021-06-07 16:18:28 -05:00
Kumar Gala 79a6c07536 release: Updates for v2.6.0
VERSION and conf.py updates for v2.6.0 release

Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2021-06-04 16:07:47 -05:00
Kumar Gala 93ccb58997 doc/releases: v2.6.0: Updates for release
* Fix header for release
* Update issues before release

Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2021-06-04 16:07:47 -05:00
Kumar Gala 36a24329f8 doc/ref/api: Update API Version Modified
Update API Version Modified field for things that changed
for the 2.6.0 release.

Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2021-06-04 15:04:53 -05:00
David Brown f6b22ecc74 doc: security: Add CVE-2021-3581 to docs
Update release notes for 2.6, and the vulnerabilities page to mention
CVE-2021-3581.  This CVE is under embargo until Sept 4, 2021.

Signed-off-by: David Brown <david.brown@linaro.org>
2021-06-04 13:57:40 -05:00
Gerard Marull-Paretas b1aefca2d3 doc: add example application to the release notes
Mention the example application as a major enhancement and provide a
link to its repository.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2021-06-04 12:50:41 -05:00
Gerard Marull-Paretas c1a97ac5c6 doc: application: add details on example-application
Mention example-application as a reference application.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2021-06-04 12:50:41 -05:00
Torsten Rasmussen e08a7f5845 doc: Zephyr build configuration CMake package freestanding
Update to the Zephyr build configuration CMake package documentation
with description on how a Zephyr build configuration CMake package can
be located outside a Zephyr workspace.

Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2021-06-04 12:50:28 -05:00
Kumar Gala fac1a5e09e doc/releases: v2.6.0: minor updates
* Added a bullet about new storage subsystem feature
* Moved disk subsystem changes into disk section

Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2021-06-04 12:33:56 -05:00
Flavio Ceolin b06d084488 docs: pm: System power management diagram
Add a diagram for system power management.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2021-06-03 14:12:52 -05:00
Kumar Gala af75587e39 doc/releases: v2.6.0: add resolved issues
Add list of all resolved issues since 2.5.0.

Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2021-06-03 12:15:21 -05:00
Maureen Helm 0aeb6788b6 doc: release: Add NXP-related changes to v2.6.0 release notes
Adds v2.6.0 release notes for NXP boards.

Signed-off-by: Maureen Helm <maureen.helm@nxp.com>
2021-06-03 10:09:35 -05:00
Maureen Helm 4f3a76a329 doc: release: Add sensor changes to v2.6.0 release notes
Fills in the sensor drivers section of the v2.6.0 release notes.

Signed-off-by: Maureen Helm <maureen.helm@nxp.com>
2021-06-03 10:09:35 -05:00
Johann Fischer 92afba6278 doc: release-notes-2.6: add release notes for USB
Add release notes for USB.

Signed-off-by: Johann Fischer <johann.fischer@nordicsemi.no>
2021-06-03 08:43:06 -05:00
Johann Fischer d7707b482c doc: release-notes-2.6: add release notes for disk drivers
Add release notes for disk drivers.

Signed-off-by: Johann Fischer <johann.fischer@nordicsemi.no>
2021-06-03 08:43:06 -05:00
Carles Cufi cb8c90e62b doc: gs: Clearly state the main dependencies min version
Introduce a table with the minimum version required for the three main
dependencies (CMake, Python and DTC). At the same time remove the CMake
help code from the GSG, since it's just a duplicate of the instructions
that Kitware provides.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
Co-authored-by: Ruth Fuchss <ruth.fuchss@nordicsemi.no>
2021-06-03 13:40:14 +02:00
Carles Cufi 3260ed187f doc: intro: Add a reference to ARMv8-R
Specify that 64-bit Cortex-R, ARMv8-R, is now supported in Zephyr.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2021-06-03 13:40:14 +02:00
Kumar Gala 733eaa29b9 doc/releases: v2.6.0: Updates
* Removed ARCH POSIX, driver/pinmux, updatehub, settings, random, POSIX
  subsystem, and LGVL sections as no significant changes this release
* Add new drivers for eeprom, timer and watchdog sections
* Added bullet item about shared interrupt support being devicetree
  based
* Added bullet about moving of CMSIS portability headers

Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2021-06-02 16:46:22 -05:00
Gerard Marull-Paretas 328e842043 doc: scripts: gen_devicetree_rest: add workaround for page width
Since Zephyr docs switched to fixed-width, the binding pages are not
displayed correctly. We should move to another data representation
format that works better for fixed-width documents. Until this decision
is made, add a workaround that forces the template to expand page width
to the maximum on binding pages.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2021-06-02 12:13:13 -05:00
Dominik Ermel ed4072838b doc/releases: v2.6.0: Update to MCUmgr and Shell section
Short update to list of changes to MCUmgr that impact Zephyr.
Note to Shell on changes that affect mcumgr.

Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
2021-06-02 08:50:11 -05:00
Kumar Gala e35e7e1d59 doc/releases: v2.6.0: Updates and cleanups
* Add high level bullets about tracing & power mgmt
* Removed duplicated bluetooth section
* Remvoed RISC-V section, to changes of note for this release

Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2021-06-02 08:15:02 -05:00
Aymeric Aillet d37ecbddbb doc/releases: v2.6.0 Add new R-Car platform drivers
Add to the v2.6 release note all Renesas R-Car drivers
that have been merged during this period.

Signed-off-by: Aymeric Aillet <aymeric.aillet@iot.bzh>
2021-06-02 06:40:15 -05:00
Flavio Ceolin 4889f4f5cc docs: release notes: Simple tags fixes
Fix some wrong tags usage.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2021-06-01 15:41:08 -05:00
Flavio Ceolin bfa581dcb5 docs: release notes: PM release notes
Add notes about PM changes during this release cycle.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2021-06-01 15:41:08 -05:00
Flavio Ceolin d5cdbcbc63 docs: release notes: PM API changes
Add information about API changes in device runtime PM.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2021-06-01 15:41:08 -05:00
Anas Nashif 22941f38e1 release notes: document removed x86 boards
Document removed boards.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2021-06-01 14:06:56 -05:00
Anas Nashif 11b8dd85b9 boards: minnowboard: remove untested and old board
Remove minnowboard configuration which is very basic and can be brought
back by just taking another X86 configuration. We have not tested this
board for a while and it is not being used actively, so remove it.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2021-06-01 14:06:56 -05:00
Anas Nashif 86209aced7 boards: qemu_x86_coverage: remove board testing coverage
This board was added to test coverage feature when coverage was
introduced. This is now being testing with other boards and
configurations on a regular basis, so no need for this extra overhead in
CI.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2021-06-01 14:06:56 -05:00
Martí Bolívar 1b4fcc44df doc: release-notes-2.6: west extensions
Just the extensions changes for Zephyr 2.6, since west has its own
release notes page as it's developed on its own pace.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2021-06-01 07:26:33 -05:00
Martí Bolívar 91f0212399 doc: add docs for west spdx
These are based on the commit log in
fd31b9b4ac.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2021-06-01 07:26:33 -05:00
Krzysztof Chruscinski f0b4376592 doc/releases: v2.6.0: Update for logging subsystem
Update release notes with logging v2 info.

Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2021-06-01 07:25:47 -05:00
Ioannis Glaropoulos c9656cfadc doc: release notes: remove blank lines
Remove blank lines between bullet points.

Signed-off-by: Ioannis Glaropoulos <Ioannis.Glaropoulos@nordicsemi.no>
2021-05-28 12:20:07 -05:00
Ioannis Glaropoulos bcbb7840a5 doc: release: release notes for Cortex-R
v2.6.0 release notes for Cortex-R.

Signed-off-by: Ioannis Glaropoulos <Ioannis.Glaropoulos@nordicsemi.no>
2021-05-28 12:20:07 -05:00
Ioannis Glaropoulos 4011c332bd doc: release: final release notes for cortex-m
Finalize v2.6.0 release notes for ARM Cortex-M.

Signed-off-by: Ioannis Glaropoulos <Ioannis.Glaropoulos@nordicsemi.no>
2021-05-28 12:20:07 -05:00
Anas Nashif f28d891c21 doc: release notes: update tracing section
Update tracing section for the v2.6 release.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2021-05-28 11:33:57 -05:00
Mulin Chao 333266250c doc: release: v2.6: add note for UART console input expired options
Add note for UART console input expired mechanism Kconfig options.

Signed-off-by: Mulin Chao <mlchao@nuvoton.com>
2021-05-28 11:33:46 -05:00
Torsten Rasmussen 9bfae0d1c0 doc: release notes: added oneApi toolchain to release notes
Adding Intel oneApi as new toolchain supported in Zephyr.

Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2021-05-28 11:31:57 -05:00
Enjia Mai feaf46ed86 doc: release-notes-2.6: Added and refined some testcases of kernel
1.Added or refined some testcases, most of them are neagtive tests, to
  improve the test code coverage.

2.Provide test excution time per ztest testcase.

3.Add a feature which handles pytest script in twister and provide an
  example.

Signed-off-by: Enjia Mai <enjiax.mai@intel.com>
2021-05-28 11:00:43 -05:00
Torsten Rasmussen 9bfa0ae1e8 doc: toolchains: move description of alternative install method on mac
On macOS there exists an alternative install method for gnuarmemb.

Unfortunately this information was located with the Intel oneApi
toolchain description and not the GNU arm Embedded toolchain.

Move the description to its correct location.

Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2021-05-28 10:59:18 -05:00
Gerard Marull-Paretas e253bbdc1f doc: release: add documentation changes
Add a list of most relevant documentation changes.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2021-05-28 10:58:33 -05:00
Kumar Gala 3c04f0c433 docs: Change a number of 'master' branch refers to 'main'
Now that we use 'main' for git development, update the docs to reflect
or point there instead of 'master'.

Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2021-05-28 10:45:17 -05:00