third_party.pigweed.src/pw_assert_log/docs.rst
Ewout van Bekkum 6f38a822ba pw_assert_log: fix pw_assert_HandleFailure to use FATAL
Fixes the pw_assert_HandleFailure implementation provided by
pw_assert_log by using PW_LOG_LEVEL_FATAL instead of
PW_LOG_LEVEL_CRITICAL.

Also updates the stale documentation to refer to the new
mechanism of using the fatal log level instead of a flag.

Change-Id: I738be4e5bea8307975001ab28b55999db32d6787
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/52480
Reviewed-by: Wyatt Hepler <hepler@google.com>
Commit-Queue: Auto-Submit <auto-submit@pigweed.google.com.iam.gserviceaccount.com>
Pigweed-Auto-Submit: Ewout van Bekkum <ewout@google.com>
2021-07-08 21:43:30 +00:00

20 lines
616 B
ReStructuredText

.. _module-pw_assert_log:
=============
pw_assert_log
=============
--------
Overview
--------
This assert backend implements the ``pw_assert`` facade, by routing the assert
message into the logger with the ``PW_LOG_LEVEL_FATAL`` log level. This is an
easy way to tokenize your assert messages, by using the ``pw_log_tokenized``
log backend for logging, then using ``pw_assert_log`` to route the tokenized
messages into the tokenized log handler.
To use this module:
1. Set your assert backend: ``pw_assert_BACKEND = dir_pw_assert_log``
2. Ensure your logging backend knows how to handle the assert failure flag