about summary refs log tree commit diff
path: root/src/libnm-core-public/README.md
blob: 0737269d1c9c2a7fd30b98b0f1b0a5021bc1d71f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
libnm-core-public
=================

This contains (mostly) header files only, which are also part of
the public API of [`libnm`](../../libnm).

Also, this API is implemented by the static library [`libnm-core-impl`](../libnm-core-impl),
which in turn is statically linked into NetworkManager core and [`libnm`](../../libnm).

These headers can be used by anybody who either:

- links (statically) against [`libnm-core-impl`](../libnm-core-impl).
- links dynamically against [`libnm`](../../libnm).

Note that there is also one source file: `nm-core-enum-types.c`.
This source file really belongs to [`libnm-core-impl`](../libnm-core-impl) but it is here
because it's a generated file and so far I couldn't figure out how
to generate `nm-core-enum-types.h` here while moving `nm-core-enum-types.c`
to [`libnm-core-impl`](../libnm-core-impl).

Aside `nm-core-enum-types.c`, this directory only provides header files.
Users should add this directory (both srcdir and builddir) to the include
search path, because libnm users are used to include these headers unqualified
(like `#include "nm-setting.h`).