Commit Graph

37 Commits

Author SHA1 Message Date
Anas Nashif 9d3be3720a doc: move module related doc to guides
Move to a new guide which will expand on how to submit modules and how
to maintain them.

Also move topology documentation to repository management section where
it fits better.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-05-21 21:45:00 -04:00
Kumar Gala db8d32881f doc: releases: Add device tree related changes
Add items on major changes related to device tree usage in this release.

Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2019-04-16 12:38:59 -05:00
David B. Kinder 7848215334 doc: review edits on 1.14 release notes
Clean up accumulated release notes with (final) clarity edits, spell
check, and such.  Remove "Working Draft" from the heading.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-04-15 18:13:07 -04:00
Anas Nashif c0abb410ce release: add more highlights from the kernel
Update with more kernel highlights.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-04-15 14:02:22 -04:00
Andy Ross c5b2aad94f doc: More kernel release notes for 1.14
Add notes on timer, SMP and x86_64

Signed-off-by: Andy Ross <andy@ajross-mobl.jf.intel.com>
2019-04-15 12:52:38 -04:00
Anas Nashif 802098dca3 release: add list of fixed bugs
Add list of fixed bugs to release notes.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-04-15 11:14:38 -04:00
Anas Nashif 06ab394f05 release: rework release notes, add highlights
Reformat notes and add highlights.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-04-14 17:08:54 -04:00
Torsten Rasmussen 10327e59c6 doc: Add to 1.14 release notes zephyr modules
Added information to release notes about Zephyr modules which allow for
splitting ext/ into multi-repo instead using Zephyr modules.

Signed-off-by: Torsten Rasmussen <torsten.rasmussen@nordicsemi.no>
2019-04-13 08:45:04 -04:00
Flavio Ceolin d1176d1789 doc: relnotes: add notes about MISRA-C
Update release notes with MISRA-C info.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2019-04-13 08:00:19 -04:00
Andrew Boie 5d6aaeb88b doc: relnotes: add notes for x86 and userspace
Update release notes for changes in 1.14.

Signed-off-by: Andrew Boie <andrew.p.boie@intel.com>
2019-04-13 07:59:53 -04:00
Sebastian Bøe c15545d4d4 doc: relnotes: 1.14 Build and Infrastructure release notes
Add more release notes for the build system for version 1.14.

Signed-off-by: Sebastian Bøe <sebastian.boe@nordicsemi.no>
2019-04-12 17:58:18 -04:00
Robert Lubos a886a28450 doc: relnotes: 1.14 nrf 802.15.4 radio driver update
nRF 802.15.4 radio driver was updated, hence mention it in release
notes.

Signed-off-by: Robert Lubos <robert.lubos@nordicsemi.no>
2019-04-12 10:08:05 -04:00
Andrzej Głąbek 4438c1a5fe doc: relnotes: 1.14 add a few more drivers related release notes
Add more drivers related release notes for version 1.14.

Signed-off-by: Andrzej Głąbek <andrzej.glabek@nordicsemi.no>
2019-04-12 08:29:06 -04:00
Anas Nashif a942fcc23e doc: release notes cleanup
Added ARC related changed and cleaned up bullets.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-04-11 23:57:12 -04:00
Krzysztof Chruscinski aa9f0ec2fa doc: relnotes: 1.14 logging, shell, ring_buf and drivers release notes
Added release notes for 1.14 release.

Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-04-11 17:51:21 -04:00
Maureen Helm dd7ccd590d doc: releases: Add drivers to 1.14 release notes
Adds new and significantly modified drivers to the 1.14 release notes.

Signed-off-by: Maureen Helm <maureen.helm@nxp.com>
2019-04-11 17:49:40 -04:00
Maureen Helm 720ce48e2f doc: releases: Add Arm, RISC-V, and shield boards to 1.14 release notes
Adds all the new Arm, RISC-V, and shield boards to the 1.14 release
notes.

Signed-off-by: Maureen Helm <maureen.helm@nxp.com>
2019-04-11 17:49:40 -04:00
Johan Hedberg 44bfefce14 doc: relnotes: 1.14 Bluetooth Host release notes
Add major changes for Bluetooth Host since 1.13.

Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
2019-04-11 10:40:57 -04:00
Carles Cufi d3f56d60dc doc: relnotes: 1.14 Bluetooth Controller release notes
Add the relevant release notes for the Bluetooth Controller for version
1.14.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2019-04-11 10:40:57 -04:00
Ioannis Glaropoulos 7886d50f2c doc: relnotes: 1.14 arm arch release notes
Release notes entries for ARM architecture.

Signed-off-by: Ioannis Glaropoulos <Ioannis.Glaropoulos@nordicsemi.no>
2019-04-11 10:40:31 -04:00
Ioannis Glaropoulos 3e61917254 doc: relnotes: 1.14 arm SoC/Boards release notes
Release notes entries for ARM SoC and Board support.

Signed-off-by: Ioannis Glaropoulos <Ioannis.Glaropoulos@nordicsemi.no>
2019-04-11 10:40:31 -04:00
Andrzej Puzdrowski e015661b94 doc: relnotes: 1.14 update documentation improvement patagtaph
Update the relevant release notes for the documentation improvement
for version 1.14.

Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
2019-04-11 10:38:45 -04:00
Andrzej Puzdrowski b607d48031 doc: relnotes: 1.14 nRF5 flash driver release notes
Add the relevant release notes for the nRF flash driver for version
1.14.

Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
2019-04-11 10:38:45 -04:00
Andrzej Puzdrowski 480c5d00f2 doc: relnotes: 1.14 settings release notes
Add the relevant release notes for the settings for version
1.14.

Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
2019-04-11 10:38:45 -04:00
Andrzej Puzdrowski 5e52d3a11d doc: relnotes: 1.14 flash_map release notes
Add the relevant release notes for the flash_map for version
1.14.

Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
2019-04-11 10:38:45 -04:00
Alberto Escolar Piedras 1923a04ff0 doc: Add to 1.14 release notes native_posix and nrf52_bsim changes
Added information to the release notes about the new drivers
in native_posix, the new nrf52_bsim board and the BabbleSim
integration in CI and testcases.

Signed-off-by: Alberto Escolar Piedras <alpi@oticon.com>
2019-04-10 12:41:51 -04:00
David B. Kinder 2e5172dab7 doc: update 1.14 release notes with doc changes
Update 1.14 draft release notes with doc changes.  Also edited existing
release notes material to make sentence tense consistent (past tense).

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-04-10 07:37:04 -04:00
David B. Kinder b379030724 doc: tweak index and release notes index for 1.14
Update the release notes page to include the 1.14 release notes
(currently a draft in progress), and update the main index page to
clarify how to get to documentation for other Zephyr versions.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-04-05 14:49:19 -04:00
Andy Gross 122eb7b647 doc: release-notes: Add security vulnerabilities
This patch adds information about the security vulnerabilities being
fixed in the 1.14 release.

Add a intro statement that these issues were addressed,
and include x86 vulnerabilities addressed in this release.

Signed-off-by: Andy Gross <andy.gross@linaro.org>
2019-04-04 22:31:28 -04:00
David B. Kinder 5d8e367efe doc: fix misspelling in docs and API comments
Fix misspellings missed during regular reviews.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-03-27 15:59:09 -04:00
Jukka Rissanen 622e49394a doc: net: Re-apply the networking release notes for 1.14
This is a revert of 45a4fbf2ae and
this commit removes the offending function references from
Networking chapter in 1.14 release note. After the BSD socket
documentation adds the function references we can revisit the
release note and add back the function references.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2019-03-15 10:35:46 -05:00
Kumar Gala 45a4fbf2ae Revert "doc: Add networking information to 1.14 release note"
This reverts commit fe9f85464c.

Getting the following issues:

releases/release-notes-1.14.rst:60: WARNING: 'any' reference target not found: getnameinfo
releases/release-notes-1.14.rst:60: WARNING: 'any' reference target not found: shutdown
releases/release-notes-1.14.rst:60: WARNING: 'any' reference target not found: freeaddrinfo
releases/release-notes-1.14.rst:60: WARNING: 'any' reference target not found: gethostname
releases/release-notes-1.14.rst:60: WARNING: 'any' reference target not found: getsockopt
releases/release-notes-1.14.rst:60: WARNING: 'any' reference target not found: setsockopt
releases/release-notes-1.14.rst:60: WARNING: 'any' reference target not found: select

Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2019-03-15 08:02:15 -05:00
Jukka Rissanen fe9f85464c doc: Add networking information to 1.14 release note
Contains major networking changes between 1.13 and 1.14 releases.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2019-03-15 06:48:41 -05:00
David B. Kinder 6000a6205a doc: prepare for improving doc API linking
Linking to API material requires knowing the pecularities of how
doxygen, sphinx, and breathe work. In an attempt to hide some of this
we're preparing the current docs to allow use of configuration defaults
that will let us more simply use a default role that will hunt for a
reference target in the various domains that are available by using a
default "role" of "all".  This will let us use the simple notation
`functionname` or `typename` without fully specifying the reference as
:c:func:`functionname`.

This patch cleans up exising docs that were (incorrectly) using single
backtics where double backtics should have been used, and also found
some typos (such as a space between the role name and the reference,
such as :file: `filename`, and a missing colon such as
c:func:`functionname`)

This is a start to address issue #14313

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-03-15 05:47:19 +01:00
David B. Kinder 8164505aad doc: Release notes initial (empty) draft
Get things started for the 1.4 release notes.
Individual teams will update their appropriate sections.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-03-13 05:36:39 -05:00
Anas Nashif 2b9458c378 doc: restructure and create index pages
Move all lead pages to be index pages and create redirect rules from the
old pointers.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-02-05 07:04:40 -05:00
Anas Nashif 96140fa029 doc: move release notes to own folder
Remove release note noise into a new folder.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-02-05 07:04:40 -05:00