Commit graph

2,703 commits

Author SHA1 Message Date
Georgij Cernysiov
c41320eb82 doc: guides: debugging: probes: correct J-Link usage
Corrects information regarding J-Link usage with ST-Link.

Signed-off-by: Georgij Cernysiov <g.cernysiov@elco-automation.de>
2019-04-19 13:56:28 -05:00
Antony Pavlov
74be380fa4 doc: application: fix duplicated word
The word 'entries' was duplicated.

Signed-off-by: Antony Pavlov <antonynpavlov@gmail.com>
2019-04-19 08:19:59 -04:00
Carles Cufi
d9f53455e5 doc: extract_content: Allow for absolute paths in deps
The dependencies in the scripts are figures, images, includes or literal
includes. Typically those dependencies are placed relative to the .rst
file that is being copied, but in some instances you might want them to
refer to an absolute path which, in fact, is relative to Sphinx's
top-level source directory. In this case, and as long as the top-level
source directory is provided, do not emit a warning.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2019-04-18 17:52:49 -04:00
Marti Bolivar
1e6f4bd1f6 doc: guides: add "Asking for Help" guide
I often wish I had a short and Zephyr-specific place to point people
to when they're asking for help in ways that make it hard to help
them.

Add one.

Signed-off-by: Marti Bolivar <marti.bolivar@nordicsemi.no>
2019-04-18 16:46:37 -04:00
Ulf Magnusson
60c395024f genrest: Include all parents in menu paths
Previously, symbols not defined with 'menuconfig' with children weren't
listed in the children's menu paths. It was deliberate, but it's
probably an anti-feature in retrospect, because it can make it harder to
find stuff by following the menu path.

Don't try to be clever and just list all the parent nodes in the menu
path.

Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-04-18 08:47:15 -04:00
Sebastian Bøe
397abd41c8 cmake: DT: Add support for out-of-tree binding root directories
Just like board's can be placed in out-of-tree BOARD_ROOT's, we now
support DeviceTree sources and bindings being placed in out-of-tree
DTS_ROOT's.

This required for out-of-tree drivers that use DeviceTree.

To implement this we get rid of various user-settable CMake variables
like DTS_APP_BINDINGS, DTS_APP_INCLUDE, and instead have ZEPHYR_BASE,
APPLICATION_SOURCE_DIR and out-of-tree directories conform to using
the same DTS_ROOT concept and directory structure.

Signed-off-by: Sebastian Bøe <sebastian.boe@nordicsemi.no>
2019-04-17 16:25:41 -05:00
Carles Cufi
b7c75915e0 west: build: Add new pristine cmd-line and config option
Add a new command-line and build config option, `pristine`, that the
user can pass to `west build` or set in its configuration file(s) in
order to automatically trigger a pristine build on every build or
whenever west considers it required.

The option can take the following values:

- never: Never run the target
- always: Always run the pristine target before building
- auto: Run the pristine target when required

With `auto`, the pristine target will be run when running
west with an existing build folder containing a build system and:

- Selecting a different board from the one currently in the build system
- Selecting a different application from the one currently in the build
  system

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2019-04-17 10:02:46 -04:00
Alberto Escolar Piedras
0eec5dba53 doc: labels: Add links to feature process
Added a few links in the labels description section
to the feature process section.

Signed-off-by: Alberto Escolar Piedras <alpi@oticon.com>
2019-04-17 09:39:44 -04:00
David B. Kinder
9d04f03bab doc: add missing doc top labels
All docs should have a label at the top that would
permit cross-document linking via :ref:`labelname`.

Update "testing" label that would have conflicted and fix the only
reference to the old "testing" label in development process
documentation.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-04-16 18:11:30 -04:00
Kumar Gala
cdf55d813b doc: changes for 1.14 documentaiton release
Doc changes listed in the release checklist (#9898)

Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2019-04-16 14:48:23 -05: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
Ioannis Glaropoulos
7f478a5d29 doc: guides: porting: fix nRF51 Cortex-m core
nRF51xx SoCs have an ARM Cortex-M0 core, not an ARM Cortex-M0+.

Signed-off-by: Ioannis Glaropoulos <Ioannis.Glaropoulos@nordicsemi.no>
2019-04-12 10:28:02 -05: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
David B. Kinder
f38aa2e301 doc: improve visibility of doc version menu
Move the doc version selection menu from the bottom of the left nav menu
to above the TOC menu, making it more obvious.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-04-12 09:37:15 -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
David B. Kinder
9fff548c88 doc: add orphaned crypto docs
tinycrypt documentation wasn't included in the table of contents so add
it into the guides section.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-04-11 08:08:28 -04:00
Johan Hedberg
91139c1534 doc: bluetooth: Clarify notes about blocking in the RX thread
Callbacks called from the RX thread may block, but should avoid doing
it for long periods of time.

Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
2019-04-10 17:43:55 -04:00
Johan Hedberg
c5e826e8ff doc: bluetooth: Move L2CAP text from to API reference section
Move the L2CAP text from the guides section to the API reference
section.

Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
2019-04-10 17:43:55 -04:00
Johan Hedberg
bf31fbd789 doc: bluetooth: Move GATT text to API reference section
Move the GATT text from the guides section to the API reference.

Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
2019-04-10 17:43:55 -04:00
Johan Hedberg
d34128a97b doc: bluetooth: Add reference to Mesh API section
Add a reference from the architecture guide to the Mesh API section.

Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
2019-04-10 17:43:55 -04:00
Johan Hedberg
eb46f47a8d doc: bluetooth: Fix text corruption
For some reason there were garbage characters at the end of the line.

Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
2019-04-10 17:43:55 -04:00
Johan Hedberg
83b443aa2d doc: bluetooth: Move connection management text to API reference
Move the connection management text from the Guides section to the API
reference section.

Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
2019-04-10 17:43:55 -04:00
Alberto Escolar Piedras
6a70f397ff doc: Reorganize development model section
Renamed the page "review_process.rst" to "dev_env_and_tools.rst"
as the old name did not cover all its content.
Moved the labels page content into this
"Developemnt Environment and Tools" page.

Signed-off-by: Alberto Escolar Piedras <alpi@oticon.com>
2019-04-10 12:58:43 -04:00
Alberto Escolar Piedras
ee194c375a doc: dev_process: Add description about GH labels usage
There has been some confusion about how GitHub labels
should be used.
This commit adds a new doc page, which tries to clarify this.

Signed-off-by: Alberto Escolar Piedras <alpi@oticon.com>
2019-04-10 12:58:43 -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
Anas Nashif
ceca823b59 doc: remove references to IRC
Remove references to IRC and mention Slack instead.

Fixes #15266

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-04-09 07:53:31 -04:00
Piotr Mienkowski
d38ffedd4d doc: add example of how to build MCUBoot app with west
This commit extends existing documentation by providing an example
of how to build Hello World sample application for MCUboot using
west.

Signed-off-by: Piotr Mienkowski <piotr.mienkowski@gmail.com>
2019-04-08 19:37:39 -04:00
Anas Nashif
15ca53dbba doc: development process: feature tracking
Add section about adding features and feature tracking.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-04-08 19:00:12 -04:00