Commit Graph

3111 Commits

Author SHA1 Message Date
Ioannis Glaropoulos
3e0251297e doc: release notes: add notes for board/SoC removals
Add entries in the release notes for ARM Musca-A
and nRF5340 PDK board and SoC removals.

Signed-off-by: Ioannis Glaropoulos <Ioannis.Glaropoulos@nordicsemi.no>
2021-02-16 08:33:12 -05:00
Anas Nashif
acf42a22fd doc: add draft for 2.6 release notes
Add draft for the 2.6 release notes.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2021-02-15 16:46:04 -06:00
Daniel Leung
ce44048d46 x86: rename CONFIG_SSE* to CONFIG_X86_SSE*
This adds X86 keyword to the kconfigs to indicate these are
for x86. The old options are still there marked as
deprecated.

Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2021-02-15 08:21:15 -05:00
Ioannis Glaropoulos
2573f4b99c tests: remove nrf5340 PDK boards from test .yml files
Remove references to the nRF5340 PDK boards
from samples and tests .yml files.

Signed-off-by: Ioannis Glaropoulos <Ioannis.Glaropoulos@nordicsemi.no>
2021-02-15 07:59:43 -05:00
Anas Nashif
39d7d34710 release: add more fixes issues to notes
Add more resolved issues to notes.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2021-02-14 09:58:55 -05:00
Anas Nashif
554fca0e5c release: make release notes final
Remove "Working Draft" from title.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2021-02-14 09:58:55 -05:00
Anas Nashif
ccc185be63 doc: add 2.5.0 to pick list
Add 2.5 to release list to be shown on documentation side bar.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2021-02-14 09:58:55 -05:00
Andrzej Głąbek
c2b5e68953 doc: release-notes-2.5: Add notes for ADC and PWM
Plus one note about the nrf_qspi_nor driver.

Signed-off-by: Andrzej Głąbek <andrzej.glabek@nordicsemi.no>
2021-02-12 11:06:40 -05:00
Jennifer Williams
af81648a18 doc: releases: 2.5: add misc x86 to boards and socs
Add misc changes still needed in release notes for
x86 Boards and SoCs after checking their history:
- zefi.py: Use cross compiler while building zephyr
- boards: x86: ehl_crb: Add board variant for Slim Bootloader
- tests: enable the code coverage report for qemu_x86_64
- drivers/timer: Remove legacy APIC driver
- x86: add common memory.ld
- x86: reserve the first megabyte

Signed-off-by: Jennifer Williams <jennifer.m.williams@intel.com>
2021-02-11 16:57:12 -05:00
Jennifer Williams
54b7439cae doc: releases: fix format issue in Boards & SoCs
Remove extra space character which is causing wrong format for
the bulleted list.

Signed-off-by: Jennifer Williams <jennifer.m.williams@intel.com>
2021-02-11 14:38:48 -05:00
Anas Nashif
e8317920b1 release notes: add top level bullets, misc. changes
Add top level bullets and misc. changes to other areas.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2021-02-11 12:55:18 -05:00
Anas Nashif
5a605778f8 release: add resolved issues
Add list of all resolved issues since 2.4.0.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2021-02-11 12:55:18 -05:00
Johann Fischer
902dd26908 doc: release-notes-2.5: add release notes for USB
Add release notes for USB.

Signed-off-by: Johann Fischer <johann.fischer@nordicsemi.no>
2021-02-11 08:53:00 -05:00
Anas Nashif
5d1c535fc8 license: add missing SPDX headers
Add SPDX header to files with existing license.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2021-02-11 08:05:16 -05:00
Lauren Murphy
2620cefc8e doc: fix typo in modules
Fixes typo in modules documentation.

Signed-off-by: Lauren Murphy <lauren.murphy@intel.com>
2021-02-10 20:34:23 -05:00
Alex Martens
f183d6492f doc: fix typo in condvar documentation
Fixes a typo in the condition variable documentation.
Also fixes two numbered lists not rendering correctly.

Signed-off-by: Alex Martens <alexander.martens@intel.com>
2021-02-10 11:57:59 -05:00
Martí Bolívar
b9ae1f6718 doc: west: improve troubleshooting for west update
Recommend curl -v or ssh -v.

Suggested-by: Marc Herbert <marc.herbert@intel.com>
Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2021-02-10 08:53:39 -05:00
Martí Bolívar
1803ddf54e doc: west: clean up example workspace
Suggested-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2021-02-10 08:53:39 -05:00
Martí Bolívar
0d0e472b8f doc: improve docs on building without west
Make it more obvious what needs to happen by spelling out the
commands.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2021-02-10 08:53:39 -05:00
Martí Bolívar
2f6c315f4f doc: improve manifest key docs
Create tables and Sphinx sections for the sub-keys of a manifest.

List the subsections in the same order they are documented.

This makes it easier to jump around in the document from the table of
contents and see what's in each subkey.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2021-02-10 08:53:39 -05:00
Martí Bolívar
f6958322cc doc: add missing docs for 'west zephyr-export'
Something should have been added to zephyr-cmds.rst when this
extension was added.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2021-02-10 08:53:39 -05:00
Martí Bolívar
e795a2bcaf doc: update west's workspaces.rst for 2.5
We haven't updated the example revisions in the alternate topologies
sections in a while. Update these for the upcoming 2.5 release.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2021-02-10 08:53:39 -05:00
Martí Bolívar
353efd04b1 doc: west: move advanced content out of 'basics'
With the documentation for west 0.9, the 'basics' page is completely
out of control. Reorganize it so it fits in a few pages, moving many
details out into other pages for the truly curious.

As part of this, create new pages for built-in commands (built-in.rst)
and esoteric details about workspaces (workspaces.rst).

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2021-02-10 08:53:39 -05:00
Martí Bolívar
fbcdc82067 doc: glossary: update west terms
We've got some obsolete 'west installation' usages kicking around
still.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2021-02-10 08:53:39 -05:00
Martí Bolívar
673474b020 doc: clean up west index
Rename the 'basics' page to basics.rst, adding a redirect for the old
title.

Rearrange some other index pages to improve the flow:

- Put relatively stale content in moving-to-west.rst to the bottom. I
  expect pepole have either moved west or are choosing not to.

- Promote the release notes page higher up, since that seems more
  important.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2021-02-10 08:53:39 -05:00
Martí Bolívar
e36fc11100 doc: sort redirects
Just to keep things easier to find.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2021-02-10 08:53:39 -05:00
Andrzej Puzdrowski
c7f1f2c269 doc: releasenotes 2.5: Add notes on addition fs_dir_t_init
The commit adds notes on addition on fs_dir_t_init function and its
impact on File system API.

Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
2021-02-10 08:53:17 -05:00
Flavio Ceolin
f270e17b32 doc: security: Update vulnerabilities information
Update CVEs information

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2021-02-10 07:14:53 -05:00
Flavio Ceolin
81315757cf doc: release-notes-2.5: crypto libraries
Add information about mbedTLS.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2021-02-10 07:14:53 -05:00
Flavio Ceolin
9d7457a586 doc: release-notes-2.5: Vulnerabilities addressed
Add information about vulnerabilities addressed during this release
cycle.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2021-02-10 07:14:53 -05:00
Peter Bigot
a31b3c410e doc: drivers: i2c: provide more information on I2C APIs
Although the master API is stable, the slave API has never been
documented and has only two in-tree implementations with no uses
outside of a single test application.  It is marked experimental in
this commit.

Signed-off-by: Peter Bigot <peter.bigot@nordicsemi.no>
2021-02-09 13:59:17 -05:00
Peter Bigot
b7da2e258f doc: inclusive language: reference I2C status issue
Status of addressing inclusive language concerns is embedded into the
coding guidelines.  Add a link to the corresponding issue for I2C.

Signed-off-by: Peter Bigot <peter.bigot@nordicsemi.no>
2021-02-09 13:59:17 -05:00
Peter Bigot
0866cbcd6c doc: coding guidelines: add an anchor for inclusive language guideline
Documentation for subsystems that use offensive terms by standard may
need to reference this section as justification for their continued
and new use.

Signed-off-by: Peter Bigot <peter.bigot@nordicsemi.no>
2021-02-09 13:59:17 -05:00
Flavio Ceolin
5a2f25a7c3 doc: release-notes-2.5: Power management contents
Add some high-level bullets about power management changes in 2.5.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2021-02-08 18:02:23 -05:00
Flavio Ceolin
6bae2d5ef0 docs: pm: Update central method diagram
Remove old information about DEEP SLEEP and SLEEP states.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2021-02-08 18:01:42 -05:00
Flavio Ceolin
18461fce88 docs: pm: Replace outdated documentation
Power management documentation was still using "deep sleep" and
"sleep" concepts. This commit just remove them, since they are not
longer used, and introduce the new power states defined in pm_state.

As each state has its own meaning and it is documented in the API,
lets just reference them here and avoid getting out of sync.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2021-02-08 18:01:42 -05:00
Daniel Leung
0b8fd86784 doc: release-notes-2.5: memory management related items
This adds a few lines about changes to memory management,
introduction of demand paging, and changes to x86 memory
management code.

Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2021-02-08 17:29:32 -05:00
Jennifer Williams
a8c91fd97c doc: release-notes-2.5: boards and SoCs: x86 ehl_crb acrn_ehl_crb
This adds a few lines for newly added board and SoC defintions
for Elkhart Lake (ehl_crb) and ACRN configurations (acrn_ehl_crb).

Signed-off-by: Jennifer Williams <jennifer.m.williams@intel.com>
2021-02-08 16:25:29 -05:00
Daniel Leung
c1a41a4490 doc: release-notes-2.5: kernel: add info on thread local storage
This adds a few lines about thread local storage that is being
introduced in this release.

Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2021-02-08 16:24:40 -05:00
Martin Jäger
adfd947fc7 doc: release: Add DAC release notes for v2.5.0
Adding notes regarding new TI driver and enabled support for some
more STM32 series.

Signed-off-by: Martin Jäger <martin@libre.solar>
2021-02-08 16:24:22 -05:00
Carlo Caione
484abf51f2 doc: release: v2.5.0 release notes for ARM AArch64
Zephyr v2.5.0 release notes for AArch64 architecture.

Signed-off-by: Carlo Caione <ccaione@baylibre.com>
2021-02-08 14:39:11 -05:00
Ioannis Glaropoulos
7e42108890 doc: release: v2.5.0 release notes for ARM AARCH32
Zephyr v2.5.0 release notes for AARCH32 architecture.

Signed-off-by: Ioannis Glaropoulos <Ioannis.Glaropoulos@nordicsemi.no>
2021-02-08 14:38:53 -05:00
Peter Bigot
a00740995b doc: release-notes-2.5: I2C
High-level changes in I2C subsystem since 2.4.0.

Signed-off-by: Peter Bigot <peter.bigot@nordicsemi.no>
2021-02-08 12:26:18 -05:00
Eugeniy Paltsev
b9ec64b448 doc: release notes: ARC
2.5 release notes for ARC related changes

Signed-off-by: Eugeniy Paltsev <Eugeniy.Paltsev@synopsys.com>
2021-02-08 11:49:21 -05:00
Martí Bolívar
df2980acfe doc: release-notes-2.5: devicetree
New macros etc.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2021-02-08 08:26:42 -05:00
Martí Bolívar
78ec3223e7 doc: release-notes-2.5: s/device tree/devicetree/
This is the preferred way to write it.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2021-02-08 08:26:42 -05:00
Maureen Helm
46d6a73f91 doc: release: Add NXP-related changes to v2.5.0 release notes
Adds v2.5.0 release notes for NXP boards and drivers.

Signed-off-by: Maureen Helm <maureen.helm@nxp.com>
2021-02-05 17:19:26 -05:00
Maureen Helm
59074044d9 doc: release: Add sensor changes to v2.5.0 release notes
Fills in the sensor drivers section of the v2.5.0 release notes.

Signed-off-by: Maureen Helm <maureen.helm@nxp.com>
2021-02-05 17:19:26 -05:00
Martí Bolívar
1d439efbb3 doc: make it clear when DT properties are deprecated
Devicetree properties may be deprecated. Make deprecated properties
more prominent in the generated bindings documentation as follows:

  1. For deprecated node-specific properties, make a new tab which
     only contains the deprecated properties

  2. For deprecated child-binding properties, ensure a line
     mentioning derpecation is in the property details

  3. For deprecated 'base' binding properties, do the same thing as
     child-bindings. Note that there aren't any such properties,
     but they'd fall in this bucket if we add any later on.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2021-02-04 13:11:01 -05:00
Peter Bigot
76ebe71fcb doc: data structures: fix description of sflist
Fix a confusing type and clarify what the alternative data structure
adds.

Signed-off-by: Peter Bigot <peter.bigot@nordicsemi.no>
2021-02-04 11:57:55 -05:00