aboutsummaryrefslogtreecommitdiff
path: root/pw_log_basic
diff options
context:
space:
mode:
authorArmando Montanez <amontanez@google.com>2020-03-13 13:06:24 -0700
committerCQ Bot Account <commit-bot@chromium.org>2020-03-17 00:13:35 +0000
commit0054a9be7053688b4001319ca7e9bce9340f9e9f (patch)
tree561dc2ca86f109859f4684bc2749fd5c9333c737 /pw_log_basic
parent59bcd9003fad77105cacc4867ec62aa8e8ba0477 (diff)
downloadpigweed-0054a9be7053688b4001319ca7e9bce9340f9e9f.tar.gz
Docs: Add missing RST docs
Adds dcos.rst files for all modules lacking documentation. Change-Id: Ief5594831d31fcb876381a4a3886382fab7d595e
Diffstat (limited to 'pw_log_basic')
-rw-r--r--pw_log_basic/BUILD.gn6
-rw-r--r--pw_log_basic/docs.rst21
2 files changed, 27 insertions, 0 deletions
diff --git a/pw_log_basic/BUILD.gn b/pw_log_basic/BUILD.gn
index 0efa82dd1..9e780585d 100644
--- a/pw_log_basic/BUILD.gn
+++ b/pw_log_basic/BUILD.gn
@@ -12,6 +12,8 @@
# License for the specific language governing permissions and limitations under
# the License.
+import("$dir_pw_docgen/docs.gni")
+
config("default_config") {
include_dirs = [ "public" ]
}
@@ -43,3 +45,7 @@ source_set("pw_log_basic_core") {
public = [ "public/pw_log_basic/log_basic.h" ]
sources = public + [ "log_basic.cc" ]
}
+
+pw_doc_group("docs") {
+ sources = [ "docs.rst" ]
+}
diff --git a/pw_log_basic/docs.rst b/pw_log_basic/docs.rst
new file mode 100644
index 000000000..2b8ca4108
--- /dev/null
+++ b/pw_log_basic/docs.rst
@@ -0,0 +1,21 @@
+.. _chapter-pw-log-basic:
+
+.. default-domain:: cpp
+
+.. highlight:: sh
+
+------------
+pw_log_basic
+------------
+``pw_log_basic`` is a ``pw_log backend`` that sends logs over ``pw_sys_io``. The
+destination of ``pw_sys_io`` depends on the ``pw_sys_io`` backend in use. This
+is controlled by the ``dir_pw_sys_io_backend`` variable in a target's
+``target_config.gni``.
+information.
+
+This module employs an internal buffer for formatting log strings, and currently
+has a fixed size of 150 bytes. Any final log statements that are larger than
+149 bytes (one byte used for a null terminator) will be truncated.
+
+.. note::
+ The documentation for this module is currently incomplete.