diff options
author | Ewout van Bekkum <ewout@google.com> | 2020-07-17 16:34:00 -0700 |
---|---|---|
committer | CQ Bot Account <commit-bot@chromium.org> | 2020-07-18 02:38:39 +0000 |
commit | e072fabcf02499a0537530ea392923c8373592b6 (patch) | |
tree | b91909f4602b811c5fc756c45818632a3f3ad392 | |
parent | 8aa0292bea75651e862c6ab3e9b5baf1b4bb2c9e (diff) | |
download | pigweed-e072fabcf02499a0537530ea392923c8373592b6.tar.gz |
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>
-rw-r--r-- | docs/module_structure.rst | 10 | ||||
-rw-r--r-- | docs/style_guide.rst | 2 | ||||
-rw-r--r-- | pw_allocator/public/pw_allocator/freelist.h | 2 | ||||
-rw-r--r-- | targets/host/target_docs.rst | 5 | ||||
-rw-r--r-- | targets/stm32f429i-disc1/target_docs.rst | 13 |
5 files changed, 16 insertions, 16 deletions
diff --git a/docs/module_structure.rst b/docs/module_structure.rst index 2f51ef054..6774ffdf7 100644 --- a/docs/module_structure.rst +++ b/docs/module_structure.rst @@ -93,7 +93,7 @@ Example module structure 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 @@ your product (e.g. for an Internet of Toast project, perhaps the prefix could 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 @@ the public interface, but are not intended for use), place the headers in a 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 @@ For example, the ``pw_unit_test`` module provides a header override for 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 f39379f87..104fe73d7 100644 --- a/docs/style_guide.rst +++ b/docs/style_guide.rst @@ -197,7 +197,7 @@ Control statements ================== 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 207edbac2..a77f7e499 100644 --- a/pw_allocator/public/pw_allocator/freelist.h +++ b/pw_allocator/public/pw_allocator/freelist.h @@ -43,7 +43,7 @@ class FreeListBuffer; // 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 3c282beda..bf83926a3 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 @@ Example: ... 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 48f64ab61..46cdf091b 100644 --- a/targets/stm32f429i-disc1/target_docs.rst +++ b/targets/stm32f429i-disc1/target_docs.rst @@ -27,14 +27,14 @@ These tests can be run on-device in a few different ways. 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 @@ specified with the ``--test`` option. .. 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 ---------------------------------- |