From 1318da19d424a2b85fba9e41689e9d99e2c0a456 Mon Sep 17 00:00:00 2001 From: Kayce Basques Date: Wed, 5 Jun 2024 23:04:15 +0000 Subject: [PATCH] pw_log: Add module metadata MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Bug: 339741960 Change-Id: I21dedae708341cdecb95d9c21347b43a245b9eb4 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/214184 Presubmit-Verified: CQ Bot Account Lint: Lint 🤖 Reviewed-by: Alexei Frolov Commit-Queue: Auto-Submit Pigweed-Auto-Submit: Kayce Basques --- docs/module_metadata.json | 9 +++++++++ pw_log/backends.rst | 3 +++ pw_log/docs.rst | 3 +++ pw_log/protobuf.rst | 3 +++ pw_log/tokenized_args.rst | 3 +++ 5 files changed, 21 insertions(+) diff --git a/docs/module_metadata.json b/docs/module_metadata.json index b3d088571..caf1eb978 100644 --- a/docs/module_metadata.json +++ b/docs/module_metadata.json @@ -211,6 +211,15 @@ "C++17" ] }, + "pw_log": { + "tagline": "Robust and portable logging for embedded projects", + "status": "stable", + "languages": [ + "C++", + "Java", + "Python" + ] + }, "pw_log_android": { "tagline": "Android logging backend", "status": "unstable", diff --git a/pw_log/backends.rst b/pw_log/backends.rst index ecb98b297..10d591b45 100644 --- a/pw_log/backends.rst +++ b/pw_log/backends.rst @@ -3,6 +3,9 @@ =============== pw_log backends =============== +.. pigweed-module-subpage:: + :name: pw_log + .. TODO: b/323607687 - Add backend guidance here .. toctree:: diff --git a/pw_log/docs.rst b/pw_log/docs.rst index c5a159ce9..01a058177 100644 --- a/pw_log/docs.rst +++ b/pw_log/docs.rst @@ -3,6 +3,9 @@ ====== pw_log ====== +.. pigweed-module:: + :name: pw_log + Pigweed's logging module provides facilities for applications to log information about the execution of their application. The module is split into two components: diff --git a/pw_log/protobuf.rst b/pw_log/protobuf.rst index ff7335f8c..b8004dea5 100644 --- a/pw_log/protobuf.rst +++ b/pw_log/protobuf.rst @@ -3,6 +3,9 @@ ------------------- The pw_log protobuf ------------------- +.. pigweed-module-subpage:: + :name: pw_log + ``pw_log`` defines a protocol buffer for storing and transmitting log messages. The protobuf is optimized to be maximally efficient. diff --git a/pw_log/tokenized_args.rst b/pw_log/tokenized_args.rst index ab52331c4..581cfc75b 100644 --- a/pw_log/tokenized_args.rst +++ b/pw_log/tokenized_args.rst @@ -3,6 +3,9 @@ ----------------------- Tokenized log arguments ----------------------- +.. pigweed-module-subpage:: + :name: pw_log + The ``pw_log`` facade is intended to make the logging backend invisible to the user, but some backend features require additional frontend support, necessitating a break in the abstraction. One of these features is the logging