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>
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>
Update the files which contain no license information with the
'Apache-2.0' SPDX license identifier. Many source files in the tree are
missing licensing information, which makes it harder for compliance
tools to determine the correct license.
By default all files without license information are under the default
license of Zephyr, which is Apache version 2.
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
Add a missing reference to how west is used to set ZEPHYR_MODULES in
without-west.rst, augmenting the application development guide a bit
to include this in the list of important variables, cleaning that up a
bit while we are here and adding some more west details.
Add a big fat warning in the getting started guide that using Zephyr
without west is not for the faint of heart.
Signed-off-by: Marti Bolivar <marti.bolivar@nordicsemi.no>
Add a note to mention how to get openocd working on windows.
This is taken from stlink-v21.rst file before its reformatting.
Signed-off-by: Erwan Gouriou <erwan.gouriou@linaro.org>
This page has been replaced by doc/guides/debugging/probes.rst and
doc/guides/debugging/host-tools.rst
Signed-off-by: Maureen Helm <maureen.helm@nxp.com>
Zephyr boards use a wide range of debug probes and debug host tools that
can often be confusing to users. Introduce a new debugging guide that
documents all the different variations of debug probes and host tools in
one place, including which combinations are valid.
Signed-off-by: Maureen Helm <maureen.helm@nxp.com>
- add glossary terms for important concepts we have to explain often,
like "west installation"
- add autodoc directives for pulling in west API docs
- add missing documentation for built-in features like west's
configuration, extension commands, etc.
- add missing documentation for "west sign" extension
- describe the manifest in a self-contained way rather than linking to
the relevant pykwalify schema, also adding a missing reference to
"west manifest" in the miscellaneous multi-repo commands list
- move various details regarding history and motivation to why.rst
among other changes to repo-tool.rst, leaving it closer to a "tell
me what I really need to know" style overview
- update planned features
Fixes: #14992
Signed-off-by: Marti Bolivar <marti@foundries.io>
1. The build paragraph was listed with the run option.
But, we need to pass an argument to the native_posix board,
so "ninja run" alone is not good enough.
Plus, it was not coherent with the rest of the text, as
the paragraph intended to tell people how to build.
2. Added "sudo" to the run line, as the user needs extra
permissions to connect to a host BT controller.
Signed-off-by: Alberto Escolar Piedras <alpi@oticon.com>
Move the original documentation in the arduino_101 board to a common
section in the Bluetooth documentation and document the use of `btmon`
in general.
Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
Added some more content to the section about how to simulate
with BabbleSim and a couple of extra links.
Signed-off-by: Alberto Escolar Piedras <alpi@oticon.com>
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>
Fixes a typo in board_porting.rst
Fixes wrong syntax for file markup element
in build-flash-debug.rst
Signed-off-by: Suryansh Sharma <suryansh@evilscientist.cc>
User mode-related API functions have been renamed to use the
'z_' prefix, so we need to update the architecture porting
guide accordingly.
Signed-off-by: Ioannis Glaropoulos <Ioannis.Glaropoulos@nordicsemi.no>
Add initial sections for the Bluetooth host stack, as well as a simple
diagram of the various protocol & profile layers.
Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
Overhaul the Bluetooth documentation to split it into manageable units
and include additional information, such as architecture and tooling.
Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
Some people never use the menuconfig, but it makes a good sanity check
when making Kconfig changes, so encourage it for that. Mention a few
things that can be checked in it.
Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
Add a section on how 'if' works to the 'Kconfig - Tips and Best
Practices' page, especially when combined with 'source'.
There seems to have been some confusion here that lead to a bunch of
duplicated dependencies. It's probably simpler than most people assume.
Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
The architecture document contained old information and is now
updated to match the reality.
Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
A new role :zephyr_file: is available that renders to a link to the file
or folder in GitHub. Find appropriate references using :file: and
convert to :zephyr_file: to take advantage of its linking capability.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
In order to simplify the usage of `west build`, take a positional
argument with the source directory instead of requiring the `-s,
--source-dir` flag. This makes it easier and quicker to invoke west when
building, as well as being consistent with CMake.
Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
There is no symbol called CONFIG_SRAM. Mention CONFIG_SRAM_SIZE and
CONFIG_SRAM_BASE_ADDRESS instead, and also mention that the DT_* values
they're generated from.
This gets rid of a false-positive undefined Kconfig symbol reference
too.
Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
CONFIG_ADC_QMSI_SAMPLE_WIDTH was removed in commit acc40d990a ("adc:
remove adc_qmsi driver"). It's only used as an example in the
documentation, but might as well use an existing symbol instead.
Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
Add a missing semicolon after /dts-v1/, and a blank line between
/dts-v1/ and the root node.
Use 'code-block:: none' instead of 'code-block:: yaml' as well.
DTS is not YAML.
Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
The connectivity API will now point to BSD socket API instead
of legacy connectivity API (net_context.h) when creating
a network application.
Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
No need to show
* native_posix board setup (native_posix_setup.rst)
* QEMU Ethernet setup (qemu_eth_setup.rst)
* QEMU SLIP setup (qemu_setup.rst)
* USBNET setup (usbnet_setup.rst)
in main network index as links to those chapters are already
found in "Networking with the host system"
(networking_with_host.rst) chapter. In order not to trigger
a doxygen warning, place the chapters into hidden toctree.
Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
Added more detailed information how to connect Zephyr instance
to host system like Linux desktop.
Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
The documentation shows the steps to be followed for generating the
code coverage reports.
Signed-off-by: Adithya Baglody <adithya.nagaraj.baglody@intel.com>
Update dts documentation.
Rework some parts to provide more clarity and elaborate
yaml bindings usage.
Fixes#10318
Signed-off-by: Erwan Gouriou <erwan.gouriou@linaro.org>
Documentation for kconfigfunctions, mentions they look up elements
in "the DTS generated "conf" style database". This indication
could be cryptic for new zephyr users. Adding the exact name and
path of the file for disambiguation.
Signed-off-by: Erwan Gouriou <erwan.gouriou@linaro.org>
Document the `west build` command in the section corresponding to the
west commands that deal with the CMake cache, which is now named
"Building, flashing and debugging" for consistency.
Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
Clarify the docs for dt_str_val that if the name isn't found we return
and empty string. Also cleanup the code slightly as we don't need to
escape the double quote.
Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
Replace generating CONFIG_ symbols with DT_ symbols for chosen
properties like 'zephyr,console' or 'zephyr,bt-mon-uart'. We now use a
kconfigfunctions (dt_str_val) to extract the info from dts into Kconfig.
Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
Since we know do DTS before Kconfig we should try and remove dts from
creating Kconfig namespaced symbols and leave that to Kconfig. So
rename CONFIG_CCM_<FOO> to DT_CCM_<FOO>.
Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
Move guides and APIs into separate directories and cleanup naming
introducing index files rather than named section files.
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
