mirror of
https://fuchsia.googlesource.com/third_party/pigweed.googlesource.com/pigweed/pigweed
synced 2024-09-21 14:16:26 +00:00
0944784e8e
This change renames the bloat_report template to pw_size_report as it is more explicit. Additionally, the option to override the global Bloaty config file on a per-report basis is removed. This is due to Pigweed's policy of having one target per build invocation. The Bloaty config is inherently tied to an executable build target and linker script, both of which are provided by the target. Overriding the Bloaty config without changing the target can result in meaningless report output. Change-Id: I1fa444d065d964a3a85ade50039e06ae807050f2
32 lines
758 B
ReStructuredText
32 lines
758 B
ReStructuredText
.. _chapter-bloat:
|
|
|
|
.. default-domain:: cpp
|
|
|
|
.. highlight:: sh
|
|
|
|
-----
|
|
Bloat
|
|
-----
|
|
The bloat module provides tools to generate size report cards for output
|
|
binaries.
|
|
|
|
.. TODO(frolv): Explain how bloat works and how to set it up.
|
|
|
|
Documentation integration
|
|
=========================
|
|
Bloat reports are easy to add to documentation files. All ``pw_size_report``
|
|
targets output a ``.rst`` file containing a tabular report card. This file
|
|
can be imported directly into a documentation file using the ``include``
|
|
directive.
|
|
|
|
For example, the ``simple_bloat`` bloat report under ``//pw_bloat/examples``
|
|
is imported into this file as follows:
|
|
|
|
.. code:: rst
|
|
|
|
.. include:: examples/simple_bloat.rst
|
|
|
|
Resulting in this output:
|
|
|
|
.. include:: examples/simple_bloat.rst
|