third_party.pigweed.src/pw_log_null/docs.rst
Wyatt Hepler f9fb90f299 docs: Make labels consistent; remove boilerplate
- Update labels so they use consistent naming. Instead of the
  copy-and-pasted `chapter` prefix, name labels with a prefix consistent
  with what they point to:
  - "module-" for module
  - "target-" for targets
  - "docs-" for general documentation
- Remove the unnecessary highlight and default-domain directives.
  Neither is necessary since the Pigweed docs always specify the
  language in code snippets and other directives.

Change-Id: I55c34e9ec919f6f4670e5d3d008e0edf5fecf05b
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/19328
Commit-Queue: Wyatt Hepler <hepler@google.com>
Reviewed-by: Keir Mierle <keir@google.com>
2020-10-01 21:47:35 +00:00

20 lines
855 B
ReStructuredText

.. _module-pw_log_null:
-----------
pw_log_null
-----------
``pw_log_null`` is a ``pw_log backend`` that ignores all ``pw_log`` statements.
The backend implements ``PW_LOG`` with an empty inline function. Using an empty
function ensures that the arguments are evaluated and their types are correct.
Since the function is inline in the header, the compiler will optimize out the
function call.
This backend can be used to completely disable ``pw_log``, which may be helpful
in certain development situations (e.g. to avoid circular dependencies).
.. tip::
If you are concerned about the resource demands of logging, try tokenizing
logs with :ref:`module-pw_tokenizer` and :ref:`module-pw_log_tokenized`
instead of disabling logs completely. Tokenized logs provide exactly same
information as plain text logs but use dramatically less resources.