pw_watch: Update syntax for pw_watch
Updates syntax for using pw_watch in a few other locations.
Change-Id: I599fc3cb552c75e9f546447556fb756633093391
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/13804
Reviewed-by: Ewout van Bekkum <ewout@google.com>
Reviewed-by: Keir Mierle <keir@google.com>
Commit-Queue: Armando Montanez <amontanez@google.com>
diff --git a/pw_watch/docs.rst b/pw_watch/docs.rst
index b5e78cc..e1967d2 100644
--- a/pw_watch/docs.rst
+++ b/pw_watch/docs.rst
@@ -31,17 +31,24 @@
$ pw watch
-By default, ``pw_watch`` will watch for repository changes and then trigger
-Ninja builds sequentially for each subdirectory in ``${PIGWEED_ROOT}/out``. To
-override this behavior, follow ``pw watch`` with paths to Ninja build
-directories like so:
+By default, ``pw_watch`` will watch for repository changes and then trigger the
+default Ninja build target for ``${PIGWEED_ROOT}/out``. To override this
+behavior, follow ``pw watch`` with the path to the build directory optionally
+followed by the Ninja targets you'd like to build:
.. code:: sh
- $ pw watch out/host
+ # Build the default target in the "out" directory.
+ $ pw watch out
- # Alternatively,
- $ pw watch --build-directory out/host --build-directory out/disco
+ # Build the "host" target in the "out" directory.
+ $ pw watch out host
+
+ # Build the "host" and "docs" targets in the "out" directory.
+ $ pw watch out host docs
+
+ # Build "host" target in "out", and "stm32f429i" target in "build_dir_2".
+ $ pw watch --build-directory out host --build-directory build_dir_2 stm32f429i
The ``--patterns`` and ``--ignore_patterns`` arguments can be used to include
and exclude certain file patterns that will trigger rebuilds.
diff --git a/targets/docs/target_docs.rst b/targets/docs/target_docs.rst
index 4cfe192..4c7601a 100644
--- a/targets/docs/target_docs.rst
+++ b/targets/docs/target_docs.rst
@@ -12,8 +12,8 @@
Building
========
-To build for this target, change the ``pw_target_config`` GN build arg to point
-to this target's configuration file.
+To build for this target, invoke ninja with the top-level "docs" group as the
+target to build.
.. code:: sh
diff --git a/targets/host/target_docs.rst b/targets/host/target_docs.rst
index 41e879f..3c282be 100644
--- a/targets/host/target_docs.rst
+++ b/targets/host/target_docs.rst
@@ -12,8 +12,8 @@
Building
========
-To build for this target, change the ``pw_target_config`` GN build arg to point
-to this target's configuration file.
+To build for this target, invoke ninja with the top-level "host" group as the
+target to build.
.. code:: sh
