NetworkManager/src/libnm-core-intern/README.md
Thomas Haller fdf9614ba7
build: move "libnm-core/" to "src/" and split it
"libnm-core/" is rather complicated. It provides a static library that
is linked into libnm.so and NetworkManager. It also contains public
headers (like "nm-setting.h") which are part of public libnm API.

Then we have helper libraries ("libnm-core/nm-libnm-core-*/") which
only rely on public API of libnm-core, but are themself static
libraries that can be used by anybody who uses libnm-core. And
"libnm-core/nm-libnm-core-intern" is used by libnm-core itself.

Move "libnm-core/" to "src/". But also split it in different
directories so that they have a clearer purpose.

The goal is to have a flat directory hierarchy. The "src/libnm-core*/"
directories correspond to the different modules (static libraries and set
of headers that we have). We have different kinds of such modules because
of how we combine various code together. The directory layout now reflects
this.
2021-02-18 19:46:51 +01:00

1,006 B

libnm-core-intern

This contains header files only, which are also part of the internal API of libnm-core-impl.

libnm-core-impl is a static library that (among others) implements libnm-core-public (which is a part of the public API of libnm). This library gets statically linked into libnm and NetworkManager. Hence, those components can also access internal (but not private) API of libnm-core-impl, and this API is in libnm-core-intern.

These headers can thus be included by anybody who statically links with libnm-core-impl (including libnm-core-impl itself).

The directory should not be added to the include search path, instead users should explicitly #include "libnm-core-intern/nm-core-internal.h")

There is no source code here and no static library to link against.