michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: west: add missing parts for zephyr v1.14

Browse source 
- 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>
This commit is contained in:
Marti Bolivar 2019-02-13 15:05:47 -07:00 • committed by Carles Cufí
commit d3bb3cfd7a
12 changed files with 1181 additions and 406 deletions
Download patch file Download diff file Expand all files Collapse all files

20
doc/glossary.rst
View file

@ -65,6 +65,26 @@ Glossary of Terms
The set of Zephyr-supplied files that implement the Zephyr kernel,
including its core services, device drivers, network stack, and so on.
west
A multi-repo meta-tool developed for the Zephyr project. See :ref:`west`.
west installation
A directory on your system with a :file:`.west` subdirectory and
a :term:`west manifest repository`. You clone the Zephyr source
code onto your system by creating a west installation using the
``west init`` command. See :ref:`west-multi-repo`.
west manifest
A YAML file named :file:`west.yml` which describes projects, or the Git
repositories which make up a :term:`west installation`, along with
additional metadata. See :ref:`west-multi-repo` for general information
and :ref:`west-manifests` for details.
west manifest repository
The Git repository in a :term:`west installation` which contains the
:term:`west manifest`. Its location is given by the :ref:`manifest.path
configuration option <west-config-index>`. See :ref:`west-multi-repo`.
XIP
(eXecute In Place) a method of executing programs directly from long
term storage rather than copying it into RAM, saving writable memory for