mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-08-27 11:09:06 +00:00
d3bb3cfd7a
- 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>
96 lines
2.3 KiB
ReStructuredText
96 lines
2.3 KiB
ReStructuredText
:orphan:
|
|
|
|
.. _west-apis:
|
|
|
|
West and Extension APIs
|
|
#######################
|
|
|
|
This page documents the Python APIs provided by :ref:`west <west>`, as well as
|
|
some additional APIs used by the :ref:`west extensions <west-extensions>` in
|
|
the zephyr repository.
|
|
|
|
**Contents**:
|
|
|
|
.. contents::
|
|
:local:
|
|
|
|
.. _west-apis-west:
|
|
|
|
West
|
|
****
|
|
|
|
This section contains documentation for west's APIs.
|
|
|
|
.. warning::
|
|
|
|
These APIs should be considered unstable until west version 1.0. Further,
|
|
until `west #38`_ is closed, these modules can only be imported from
|
|
extension command files (and within west itself, of course).
|
|
|
|
.. NOTE: documentation authors:
|
|
|
|
1. keep these sorted by package/module name.
|
|
2. if you add a :ref: target here, add it to west-not-found.rst too.
|
|
|
|
.. _west-apis-commands:
|
|
|
|
west.commands
|
|
=============
|
|
|
|
.. automodule:: west.commands
|
|
:members: WestCommand, CommandError, CommandContextError, ExtensionCommandError
|
|
|
|
.. _west-apis-configuration:
|
|
|
|
west.configuration
|
|
==================
|
|
|
|
.. automodule:: west.configuration
|
|
:members: ConfigFile, read_config, update_config
|
|
|
|
.. _west-apis-log:
|
|
|
|
west.log
|
|
========
|
|
|
|
.. automodule:: west.log
|
|
:members: set_verbosity, VERBOSE_NONE, VERBOSE_NORMAL, VERBOSE_VERY, VERBOSE_EXTREME, dbg, inf, wrn, err, die
|
|
|
|
.. _west-apis-manifest:
|
|
|
|
west.manifest
|
|
=============
|
|
|
|
.. automodule:: west.manifest
|
|
:members: manifest_path, Manifest, Defaults, Remote, Project, SpecialProject, MalformedManifest, MalformedConfig, MANIFEST_SECTIONS, MANIFEST_PROJECT_INDEX, MANIFEST_REV_BRANCH, QUAL_MANIFEST_REV_BRANCH
|
|
|
|
.. _west-apis-util:
|
|
|
|
west.util
|
|
=========
|
|
|
|
.. automodule:: west.util
|
|
:members: west_dir, west_topdir, WestNotFound
|
|
|
|
.. _west-apis-zext:
|
|
|
|
Zephyr Extensions
|
|
*****************
|
|
|
|
This section contains documentation for APIs used by the extension commands
|
|
which are part of the Zephyr repository. In particular, it documents the
|
|
``runners.core`` module used by the :ref:`west-build-flash-debug`
|
|
commands. This is the core abstraction used to implement support for these
|
|
features.
|
|
|
|
.. warning::
|
|
|
|
These APIs are provided for reference, but they are more "shared code" used
|
|
to implement multiple extension commands than a stable API.
|
|
|
|
.. automodule:: runners.core
|
|
:members:
|
|
|
|
.. _west #38:
|
|
https://github.com/zephyrproject-rtos/west/issues/38
|