commit 63c5be9f1d5c8abb81aa199906545a2e893f39b0
author Wyatt Hepler <hepler@google.com> Tue Sep 26 19:50:31 2023 +0000
committer CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> Tue Sep 26 19:50:31 2023 +0000
tree 72a92cb542ef00fe04bab04dced756187bbe7efc
parent c08b1fa74398ba27f56b29f8142ff66319d49825

pw_ring_buffer: Minor build and docs updates

Change-Id: Id1353978279e614923258625df06d4ed63ddb4c8
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/173030
Commit-Queue: Auto-Submit <auto-submit@pigweed-service-accounts.iam.gserviceaccount.com>
Pigweed-Auto-Submit: Wyatt Hepler <hepler@google.com>
Presubmit-Verified: CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Armando Montanez <amontanez@google.com>

pw_ring_buffer/BUILD.bazel

diff --git a/pw_ring_buffer/BUILD.bazel b/pw_ring_buffer/BUILD.bazel
index 467c156..7b13cbf 100644
--- a/pw_ring_buffer/BUILD.bazel
+++ b/pw_ring_buffer/BUILD.bazel
@@ -42,9 +42,7 @@
 
 pw_cc_test(
     name = "prefixed_entry_ring_buffer_test",
-    srcs = [
-        "prefixed_entry_ring_buffer_test.cc",
-    ],
+    srcs = ["prefixed_entry_ring_buffer_test.cc"],
     deps = [
         ":pw_ring_buffer",
         "//pw_unit_test",

pw_ring_buffer/BUILD.gn

diff --git a/pw_ring_buffer/BUILD.gn b/pw_ring_buffer/BUILD.gn
index 9586bdb..8702839 100644
--- a/pw_ring_buffer/BUILD.gn
+++ b/pw_ring_buffer/BUILD.gn
@@ -19,12 +19,12 @@
 import("$dir_pw_docgen/docs.gni")
 import("$dir_pw_unit_test/test.gni")
 
-config("default_config") {
+config("public_include_path") {
   include_dirs = [ "public" ]
 }
 
 pw_source_set("pw_ring_buffer") {
-  public_configs = [ ":default_config" ]
+  public_configs = [ ":public_include_path" ]
   public_deps = [
     "$dir_pw_containers",
     "$dir_pw_result",

pw_ring_buffer/docs.rst

diff --git a/pw_ring_buffer/docs.rst b/pw_ring_buffer/docs.rst
index 6738610..dba41ce 100644
--- a/pw_ring_buffer/docs.rst
+++ b/pw_ring_buffer/docs.rst
@@ -1,22 +1,25 @@
 .. _module-pw_ring_buffer:
 
---------------
+==============
 pw_ring_buffer
---------------
+==============
 The ``pw_ring_buffer`` module will eventually provide several ring buffer
 implementations, each with different tradeoffs.
 
 This documentation is incomplete :)
 
-Compatibility
-=============
-* C++14
+-----------------------
+PrefixedEntryRingBuffer
+-----------------------
+:cpp:class:`pw::ring_buffer::PrefixedEntryRingBuffer` is a circular buffer for
+arbitrary length data entries with an optional user-defined preamble byte. It
+supports multiple independent readers.
 
 Iterator
 ========
 In crash contexts, it may be useful to scan through a ring buffer that may
 have a mix of valid (yet to be read), stale (read), and invalid entries. The
-`PrefixedEntryRingBufferMulti::iterator` class can be used to walk through
+``PrefixedEntryRingBufferMulti::iterator`` class can be used to walk through
 entries in the provided buffer.
 
 .. code-block:: cpp
@@ -50,8 +53,8 @@
 
 In cases where a crash has caused the ring buffer to have corrupted data, the
 iterator will progress until it sees the corrupted section and instead move to
-`iterator::end()`. The `iterator::status()` function returns a `pw::Status`
-indicating the reason the iterator reached it's end.
+``iterator::end()``. The ``iterator::status()`` function returns a
+:cpp:class:`pw::Status` indicating the reason the iterator reached it's end.
 
 .. code-block:: cpp
 
@@ -80,8 +83,3 @@
 When these methods encounter data corruption, there is no generic way to
 recover, and thus, the application crashes. Data corruption is indicative of
 other issues.
-
-Dependencies
-============
-* ``pw_span``
-* ``pw_containers`` - for tests only