xref: /illumos-gate/usr/src/compat/bhyve/README (revision 0aaef2f550fa500248f59b0b8a14225b5afbd198)
1These are the compatibility headers for building bhyve on illumos.  They are
2comprised of the shims and glue needed to use native functionality as the
3backing for FreeBSD interfaces.  It often means heavy use of #include_next,
4#define renames, and forward definitions to some glue functions.
5
6For headers which would otherwise be copied verbatim from FreeBSD, the
7usr/src/contrib/bhyve area is the appropriate home.  This allows us to carry
8only the bare minimum in the 'compat' headers while making updates for the
9'contrib' headers easy (simply copy over the new version).
10