third_party.pigweed.src/targets/host/target_docs.rst
Ewout van Bekkum e072fabcf0 docs: some more minor updates
Fixes some errors and some stale references and formats.

Change-Id: I5a2f6d4a20591b61ae49eaab3310dc7abf51d83d
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/14122
Reviewed-by: Keir Mierle <keir@google.com>
Commit-Queue: Ewout van Bekkum <ewout@google.com>
2020-07-18 02:38:39 +00:00

48 lines
1.2 KiB
ReStructuredText

.. _chapter-host:
.. default-domain:: cpp
.. highlight:: sh
----
host
----
The Pigweed host target is used for unit testing and some host side tooling.
Building
========
To build for this target, invoke ninja with the top-level "host" group as the
target to build.
.. code:: sh
$ ninja -C out host
There are two host toolchains, and both of them can be manually invoked by
replacing `host` with `host_clang` or `host_gcc`. Not all toolchains are
supported on all platforms. Unless working specifically on one toolchain, it is
recommended to leave this to the default.
Running Tests
=============
Tests are automatically run as part of the host build, but if you desire to
manually run tests, you may invoke them from a shell directly.
Example:
... code:: sh
$ ./out/host_[compiler]_debug/obj/pw_status/status_test
Configuration
=============
The host target exposes a few options that may be used to change the host build
behavior.
pw_build_HOST_TOOLS
-------------------
Pigweed includes a number of host-only tooling that may be built as part of the
host build. These tools are included as part of the bootstrap, so it's only
necessary to enable this setting when modifying host tooling. This is
disabled by default.