Lines Matching +full:googleapis +full:- +full:gen
1 .. _docs-get-started-upstream:
9 :ref:`docs-get-started` if you're looking for instructions on how to use
22 If you haven't already, :ref:`docs-first-time-setup`.
24 -------------
26 -------------
29 all the steps to :ref:`docs-first-time-setup`. The express setup
32 #. **Host** - Mac, Linux, or Windows. Builds and runs tests
33 #. **Device/STM32F429** - Build only; Optionally, the STM32F429I-DISC1 kit to
35 #. **Docs** - Builds the Pigweed docs
44 .. code-block:: bash
61 .. code-block:: bash
63 $ gn gen out
68 .. code-block:: bash
94 #. Open the generated docs in ``out/docs/gen/docs/html/index.html`` in your
104 ``activate.bat`` on Windows) to re-activate the environment without
105 re-bootstrapping.
107 ---------
109 ---------
116 .. code-block:: bash
124 .. code-block:: batch
131 Below is a real-time demo with roughly what you should expect to see as output:
133 .. image:: https://storage.googleapis.com/pigweed-media/pw_env_setup_demo.gif
139 .. _activate-pigweed-environment:
141 ---------------------------------
143 ---------------------------------
151 .. code-block:: bash
157 .. code-block:: batch
162 into host tooling changes after a pull it may be worth re-running bootstrap.
164 ----------------------
166 ----------------------
168 builds in-development, but they are incomplete and don't have feature parity
172 `Ninja <https://ninja-build.org/>`_ build files.
180 .. code-block:: bash
182 $ gn gen out
190 Unless your build directory (the ``out`` in ``gn gen out``) is exactly one
201 Now you *could* manually invoke the host build using ``ninja -C out`` every
206 .. code-block:: bash
216 ``pw_status/public/pw_status/status.h`` and watch the build re-trigger when you
221 .. image:: https://storage.googleapis.com/pigweed-media/pw_watch_build_demo.gif
225 ------------------
227 ------------------
236 .. image:: https://storage.googleapis.com/pigweed-media/pw_watch_test_demo.gif
243 will be re-built and re-run.
247 .. code-block:: bash
254 ---------------------
256 ---------------------
260 target (the STMicroelectronics STM32F429I-DISC1) in parallel with the host
265 .. code-block:: bash
271 .. code-block:: bash
273 $ ninja -C out stm32f429i
275 -------------------------
277 -------------------------
280 pass on the host, it's crucial to verify the same with on-device testing. We've
286 Connect any number of STM32F429I-DISC1 boards to your computer using the mini
294 .. image:: https://storage.googleapis.com/pigweed-media/stm32f429i-disc1_connected.jpg
305 .. code-block:: bash
315 stm32f429i-disc1 target.
317 .. code-block:: bash
321 # on-device unit tests.
331 .. image:: https://storage.googleapis.com/pigweed-media/pw_watch_on_device_demo.gif
333 :alt: pw watch running on-device tests
335 --------------------------
337 --------------------------
339 information-rich RST files that are used to generate HTML documentation. All
343 ``out/docs/gen/docs/html``.
347 .. code-block:: bash
349 $ ninja -C out docs
353 ---------------------------
355 ---------------------------
357 waiting for the whole world to build and all tests to run. GN has a built-in
360 specify which target to build the test under (e.g. host, SM32F529I-DISC1).
364 .. code-block:: none
369 $ ninja -C out pw_strict_host_clang_debug/obj/pw_status/status_test.run.pw_pystamp
373 The ``.run`` following the test target name is a sub-target created as part of
379 .. code-block:: bash
381 …s:status_test.run(//targets/host/pigweed_internal:pw_strict_host_clang_debug)" | xargs ninja -C out
383 ----------
385 ----------
389 Ready to submit a patch upstream? See our :ref:`docs-contributing` guide for our
394 Visit :ref:`docs-get-started` to learn how to set up a new Bazel-based
395 project, how to add Pigweed to an existing Bazel-based project, and more.
400 :ref:`docs-module-guides`.
402 The :ref:`docs-kudzu` repo demonstrates how to use Pigweed in your own project.
408 Check out the :ref:`module-pw_ide` for setting up editor configurations or run
411 .. code-block:: bash
418 <https://hackaday.com/2021/01/13/remoticon-video-pigweed-brings-embedded-unit-testing-library-integ…