Alexei Frolov | 4c035b0 | 2019-11-14 16:36:15 -0800 | [diff] [blame^] | 1 | .. _chapter-bloat: |
| 2 | |
| 3 | .. default-domain:: cpp |
| 4 | |
| 5 | .. highlight:: sh |
| 6 | |
| 7 | ----- |
| 8 | Bloat |
| 9 | ----- |
| 10 | The bloat module provides tools to generate size report cards for output |
| 11 | binaries. |
| 12 | |
| 13 | .. TODO(frolv): Explain how bloat works and how to set it up. |
| 14 | |
| 15 | Documentation integration |
| 16 | ========================= |
| 17 | Bloat reports are easy to add to documentation files. All ``bloat_report`` |
| 18 | targets output a ``.rst`` file containing a tabular report card. This file |
| 19 | can be imported directly into a documentation file using the ``include`` |
| 20 | directive. |
| 21 | |
| 22 | For example, the ``simple_bloat`` bloat report under ``//pw_bloat/examples`` |
| 23 | is imported into this file as follows: |
| 24 | |
| 25 | .. code:: rst |
| 26 | |
| 27 | .. include:: examples/simple_bloat.rst |
| 28 | |
| 29 | Resulting in this output: |
| 30 | |
| 31 | .. include:: examples/simple_bloat.rst |