xref: /aosp_15_r20/external/pigweed/pw_log_null/docs.rst (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1.. _module-pw_log_null:
2
3-----------
4pw_log_null
5-----------
6``pw_log_null`` is a ``pw_log`` backend that ignores all ``pw_log`` statements.
7The backend implements ``PW_LOG`` with an empty inline function. Using an empty
8function ensures that the arguments are evaluated and their types are correct.
9Since the function is inline in the header, the compiler will optimize out the
10function call.
11
12This backend can be used to completely disable ``pw_log``, which may be helpful
13in certain development situations (e.g. to avoid circular dependencies).
14
15.. tip::
16  If you are concerned about the resource demands of logging, try tokenizing
17  logs with :ref:`module-pw_tokenizer` and :ref:`module-pw_log_tokenized`
18  instead of disabling logs completely. Tokenized logs provide exactly same
19  information as plain text logs but use dramatically less resources.
20