xref: /aosp_15_r20/external/pigweed/pw_env_setup_zephyr/docs.rst (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1*61c4878aSAndroid Build Coastguard Worker.. _module-pw_env_setup_zephyr:
2*61c4878aSAndroid Build Coastguard Worker
3*61c4878aSAndroid Build Coastguard Worker.. rst-class:: with-subtitle
4*61c4878aSAndroid Build Coastguard Worker
5*61c4878aSAndroid Build Coastguard Worker===================
6*61c4878aSAndroid Build Coastguard Workerpw_env_setup_zephyr
7*61c4878aSAndroid Build Coastguard Worker===================
8*61c4878aSAndroid Build Coastguard Worker.. pigweed-module::
9*61c4878aSAndroid Build Coastguard Worker   :name: pw_env_setup_zephyr
10*61c4878aSAndroid Build Coastguard Worker
11*61c4878aSAndroid Build Coastguard Worker   * **Integrate your Pigweed environment with Zephyr**
12*61c4878aSAndroid Build Coastguard Worker
13*61c4878aSAndroid Build Coastguard Worker---------------------
14*61c4878aSAndroid Build Coastguard WorkerZephyr kick the tires
15*61c4878aSAndroid Build Coastguard Worker---------------------
16*61c4878aSAndroid Build Coastguard WorkerThe ultimate goal of this module is to provide tools and utilities for
17*61c4878aSAndroid Build Coastguard Workerintegrating your Zephyr + Pigweed project. Some code in this python module will
18*61c4878aSAndroid Build Coastguard Workerbe used in the ``pw`` CLI, while other code will be leveraged by other
19*61c4878aSAndroid Build Coastguard Workerutilities. This module is experimental so watch out for changes.
20*61c4878aSAndroid Build Coastguard Worker
21*61c4878aSAndroid Build Coastguard WorkerCheck out the Zephyr getting started guide at :ref:`docs-os-zephyr`.
22*61c4878aSAndroid Build Coastguard Worker
23*61c4878aSAndroid Build Coastguard Worker-----------
24*61c4878aSAndroid Build Coastguard WorkerCLI options
25*61c4878aSAndroid Build Coastguard Worker-----------
26*61c4878aSAndroid Build Coastguard WorkerThis module offers a CLI integrated with the ``pw`` command as ``pw west`` which
27*61c4878aSAndroid Build Coastguard Workerprovides an easy way to work with both Zephyr + Pigweed:
28*61c4878aSAndroid Build Coastguard Worker
29*61c4878aSAndroid Build Coastguard Worker.. list-table::
30*61c4878aSAndroid Build Coastguard Worker   :header-rows: 1
31*61c4878aSAndroid Build Coastguard Worker
32*61c4878aSAndroid Build Coastguard Worker   * - Flag
33*61c4878aSAndroid Build Coastguard Worker     - Description
34*61c4878aSAndroid Build Coastguard Worker   * - ``-v``
35*61c4878aSAndroid Build Coastguard Worker     - Print verbose messages (debug)
36*61c4878aSAndroid Build Coastguard Worker
37*61c4878aSAndroid Build Coastguard Worker.. list-table::
38*61c4878aSAndroid Build Coastguard Worker   :header-rows: 1
39*61c4878aSAndroid Build Coastguard Worker
40*61c4878aSAndroid Build Coastguard Worker   * - Subcommand
41*61c4878aSAndroid Build Coastguard Worker     - Description
42*61c4878aSAndroid Build Coastguard Worker   * - ``manifest``
43*61c4878aSAndroid Build Coastguard Worker     - Print a simple West manifest which includes this instance of Pigweed and
44*61c4878aSAndroid Build Coastguard Worker       optionally the bundled version of Zephyr if ``pw package install zephyr``
45*61c4878aSAndroid Build Coastguard Worker       was run.
46