xref: /aosp_15_r20/external/pigweed/pw_hdlc/size.rst (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1.. _module-pw_hdlc-size:
2
3.. rst-class:: with-subtitle
4
5==================
6Code size analysis
7==================
8.. pigweed-module-subpage::
9   :name: pw_hdlc
10
11``pw_hdlc`` currently optimizes for robustness and flexibility instead of
12binary size or performance.
13
14The ``HDLC encode and decode`` size report shows the cost of everything needed
15to use ``pw_hdlc``, including the dependencies on common modules like CRC32
16from :ref:`module-pw_checksum` and variable-length integer handling from
17:ref:`module-pw_varint`.
18
19The ``HDLC encode and decode, ignoring CRC and varint`` size report shows the
20cost of ``pw_hdlc`` if your application is already linking CRC32 and
21variable-length integer handling. ``pw_varint`` is commonly used since it's
22necessary for protocol buffer handling, so it's often already present.
23
24.. include:: size_report
25
26-----------------
27More pw_hdlc docs
28-----------------
29.. include:: docs.rst
30   :start-after: .. pw_hdlc-nav-start
31   :end-before: .. pw_hdlc-nav-end
32