diff options
Diffstat (limited to 'pw_log/docs.rst')
| -rw-r--r-- | pw_log/docs.rst | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/pw_log/docs.rst b/pw_log/docs.rst index f809e47a4..950a82c3e 100644 --- a/pw_log/docs.rst +++ b/pw_log/docs.rst @@ -311,6 +311,8 @@ common for the ``pw_log`` backend to cause circular dependencies. Because of this, log backends may avoid declaring explicit dependencies, instead relying on include paths to access header files. +GN +== In GN, the ``pw_log`` backend's full implementation with true dependencies is made available through the ``$dir_pw_log:impl`` group. When ``pw_log_BACKEND`` is set, ``$dir_pw_log:impl`` must be listed in the ``pw_build_LINK_DEPS`` @@ -327,6 +329,18 @@ to directly provide dependencies through include paths only, rather than GN ``public_deps``. In this case, GN header checking can be disabled with ``check_includes = false``. +.. _module-pw_log-bazel-backend_impl: + +Bazel +===== +In Bazel, log backends may avoid cyclic dependencies by placing the full +implementation in an ``impl`` target, like ``//pw_log_tokenized:impl``. The +``//pw_log:backend_impl`` label flag should be set to the ``impl`` target +required by the log backend used by the platform. + +You must add a dependency on the ``@pigweed//pw_log:backend_impl`` target to +any binary using ``pw_log``. + ---------------------- Google Logging Adapter ---------------------- |