pw_log: Add module metadata

Bug: 339741960
Change-Id: I21dedae708341cdecb95d9c21347b43a245b9eb4
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/214184
Presubmit-Verified: CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>
Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com>
Reviewed-by: Alexei Frolov <frolv@google.com>
Commit-Queue: Auto-Submit <auto-submit@pigweed-service-accounts.iam.gserviceaccount.com>
Pigweed-Auto-Submit: Kayce Basques <kayce@google.com>
This commit is contained in:
Kayce Basques 2024-06-05 23:04:15 +00:00 committed by CQ Bot Account
parent 5a42d892e6
commit 1318da19d4
5 changed files with 21 additions and 0 deletions

View File

@ -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",

View File

@ -3,6 +3,9 @@
===============
pw_log backends
===============
.. pigweed-module-subpage::
:name: pw_log
.. TODO: b/323607687 - Add backend guidance here
.. toctree::

View File

@ -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:

View File

@ -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.

View File

@ -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