Blame src/libnm-core-impl/README.md

Packit Service dff8e4
libnm-core-impl
Packit Service dff8e4
===============
Packit Service dff8e4
Packit Service dff8e4
NetworkManager provides a client library [`libnm`](../../libnm).
Packit Service dff8e4
NetworkManager core does not (dynamically) link against all of libnm.
Packit Service dff8e4
Instead, it statically links against a part of it.
Packit Service dff8e4
That part is the static helper library `libnm-core-impl`.
Packit Service dff8e4
Packit Service dff8e4
`libnm-core-impl` implements (and provides) the API from
Packit Service dff8e4
[`libnm-core-public`](../libnm-core-public), which is part of the public
Packit Service dff8e4
API of [`libnm`](../../libnm). In this form, `libnm-core-impl` is part
Packit Service dff8e4
of the implementation of [`libnm`](../../libnm). It also implements (and
Packit Service dff8e4
provides) an internal API [`libnm-core-intern`](../libnm-core-intern) which
Packit Service dff8e4
can only be used by those who link statically against `libnm-core-impl`.
Packit Service dff8e4
Packit Service dff8e4
Only NetworkManager core and [`libnm`](../../libnm) are allowed to statically
Packit Service dff8e4
link with `libnm-core-impl`. Consequently, only those are allowed to include
Packit Service dff8e4
[`libnm-core-intern`](../libnm-core-intern).
Packit Service dff8e4
Packit Service dff8e4
This directory should not be added to the include search path of other
Packit Service dff8e4
components as they are only allowed to include [`libnm-core-public`](../libnm-core-public)
Packit Service dff8e4
and [`libnm-core-intern`](../libnm-core-intern).