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>
diff --git a/docs/module_structure.rst b/docs/module_structure.rst
index 2f51ef0..6774ffd 100644
--- a/docs/module_structure.rst
+++ b/docs/module_structure.rst
@@ -93,7 +93,7 @@
code_relating_to_subfeature/...
Module name
-~~~~~~~~~~~
+-----------
Pigweed upstream modules are always named with a prefix ``pw_`` to enforce
namespacing. Projects using Pigweed that wish to make their own modules can use
whatever name they like, but we suggest picking a short prefix to namespace
@@ -101,10 +101,10 @@
be ``it_``).
C++ file and directory locations
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+--------------------------------
C++ public headers
-^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~
Located ``{pw_module_dir}/public/<module>``. These are headers that must be
exposed due to C++ limitations (i.e. are included from the public interface,
but are not intended for public use).
@@ -143,7 +143,7 @@
that, there is the ``public_overrides/`` directory.
Public override headers
-^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~
Located ``{pw_module_dir}/public_overrides/<module>``. In general, the Pigweed
philosophy is to avoid having "things hiding under rocks", and having header
files with the same name that can override each other is considered a rock
@@ -175,7 +175,7 @@
Note that the overrides are in a separate directory ``public_overrides``.
C++ implementation files
-^^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~~
Located ``{pw_module_dir}/``. C++ implementation files go at the top level of
the module. Implementation files must always use "" style includes.
diff --git a/docs/style_guide.rst b/docs/style_guide.rst
index f39379f..104fe73 100644
--- a/docs/style_guide.rst
+++ b/docs/style_guide.rst
@@ -197,7 +197,7 @@
==================
All loops and conditional statements must use braces.
-The syntax ``while (true)`` if preferred over ``for (;;)`` for infinite loops.
+The syntax ``while (true)`` is preferred over ``for (;;)`` for infinite loops.
Include guards
==============
diff --git a/pw_allocator/public/pw_allocator/freelist.h b/pw_allocator/public/pw_allocator/freelist.h
index 207edba..a77f7e4 100644
--- a/pw_allocator/public/pw_allocator/freelist.h
+++ b/pw_allocator/public/pw_allocator/freelist.h
@@ -43,7 +43,7 @@
// bucket[1] (128B) --> chunk[65B] --> chunk[72B] --> NULL
// bucket[2] (256B) --> NULL
// bucket[3] (512B) --> chunk[312B] --> chunk[512B] --> chunk[416B] --> NULL
-// bucket[4] (implciit) --> chunk[1024B] --> chunk[513B] --> NULL
+// bucket[4] (implicit) --> chunk[1024B] --> chunk[513B] --> NULL
//
// Note that added chunks should be aligned to a 4-byte boundary.
//
diff --git a/targets/host/target_docs.rst b/targets/host/target_docs.rst
index 3c282be..bf83926 100644
--- a/targets/host/target_docs.rst
+++ b/targets/host/target_docs.rst
@@ -7,8 +7,7 @@
----
host
----
-The Pigweed host target assembles Pigweed's reStructuredText and markdown
-documentation into a collection of HTML pages.
+The Pigweed host target is used for unit testing and some host side tooling.
Building
========
@@ -33,7 +32,7 @@
... code:: sh
- $ ./out/host_[compiler]/obj/pw_status/status_test
+ $ ./out/host_[compiler]_debug/obj/pw_status/status_test
Configuration
=============
diff --git a/targets/stm32f429i-disc1/target_docs.rst b/targets/stm32f429i-disc1/target_docs.rst
index 48f64ab..46cdf09 100644
--- a/targets/stm32f429i-disc1/target_docs.rst
+++ b/targets/stm32f429i-disc1/target_docs.rst
@@ -27,14 +27,14 @@
Run a unit test
---------------
If using ``out`` as a build directory, tests will be located in
-``out/stm32f429i/obj/[module name]/[test_name].elf``. To run these on device,
-the stm32f429i-disc1 target provides a helper script that flashes the test to a
-device and then runs it.
+``out/stm32f429i_disc1_debug/obj/[module name]/[test_name].elf``. To run these
+on device, the stm32f429i-disc1 target provides a helper script that flashes the
+test to a device and then runs it.
.. code:: sh
# Setup pigweed environment.
- $ . pw_env_setup/setup.sh
+ $ source activate.sh
# Run test.
$ stm32f429i_disc1_unit_test_runner /path/to/binary
@@ -50,9 +50,10 @@
.. code:: sh
# Setup Pigweed environment.
- $ . pw_env_setup/setup.sh
+ $ source activate.sh
# Run test.
- $ pw test --root out/stm32f429i/ --runner stm32f429i_disc1_unit_test_runner
+ $ pw test --root out/stm32f429i_disc_debug/ \
+ --runner stm32f429i_disc1_unit_test_runner
Run tests affected by code changes
----------------------------------
