xo-umbrella2/xo-arena/docs/index.rst
Roland Conybeare c08be29994 git subrepo clone git@github.com:Rconybea/xo-arena.git xo-arena
subrepo:
  subdir:   "xo-arena"
  merged:   "5567b43c"
upstream:
  origin:   "git@github.com:Rconybea/xo-arena.git"
  branch:   "main"
  commit:   "5567b43c"
git-subrepo:
  version:  "0.4.9"
  origin:   "???"
  commit:   "???"
2026-06-06 21:38:46 -04:00

31 lines
729 B
ReStructuredText

# xo-arena documentation master file
xo-arena documentation
======================
xo-arena provides:
* Fast vm-aware arena allocation.
* Allocates uncommitted virtual memory, and commits on demand.
* When available, uses THP (Transparent Huge Pages) to mitigate pagetable pressure.
* Optional GC support, with per-alloc header.
Diagnostic features:
* with alloc headers: forward iterators over individual allocations
* configurable guard memory between allocations.
.. toctree::
:maxdepth: 2
:caption: xo-arena contents
examples
implementation
ArenaConfig-reference
DArena-reference
DArenaIterator-reference
AllocInfo-reference
cmpresult-reference
glossary
genindex
search