third_party.pigweed.src/pw_malloc_freelist/docs.rst
Wyatt Hepler f9fb90f299 docs: Make labels consistent; remove boilerplate
- Update labels so they use consistent naming. Instead of the
  copy-and-pasted `chapter` prefix, name labels with a prefix consistent
  with what they point to:
  - "module-" for module
  - "target-" for targets
  - "docs-" for general documentation
- Remove the unnecessary highlight and default-domain directives.
  Neither is necessary since the Pigweed docs always specify the
  language in code snippets and other directives.

Change-Id: I55c34e9ec919f6f4670e5d3d008e0edf5fecf05b
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/19328
Commit-Queue: Wyatt Hepler <hepler@google.com>
Reviewed-by: Keir Mierle <keir@google.com>
2020-10-01 21:47:35 +00:00

20 lines
829 B
ReStructuredText

.. _module-pw_malloc_freelist:
------------------
pw_malloc_freelist
------------------
``pw_malloc_freelist`` implements the ``pw_malloc`` facade using a freelist
heap.
``pw_malloc_freelist`` initializes a global ``FreeListHeapBuffer`` object to
organize heap usage. Implementation details are in the ``pw_allocator`` module.
``pw_malloc_freelist`` provides wrapper functions for ``malloc``, ``free``,
``realloc`` and ``calloc`` that uses the freelist implementation of heap in
``pw_allocator``. In the GN build file, ``pw_malloc_freelist`` provides linker
options needed in ``public_configs``, which will be forwarded to the facade. In
the case of freelist, we specify the wrapper functions ``malloc, free, realloc,
calloc, _malloc_r, _free_r, _realloc_r, _calloc_r`` to replace the original libc
functions at linker time.