about summary refs log tree commit diff
path: root/src/libnm-core-intern/README.md
diff options
context:
space:
mode:
authorMichael Biebl <biebl@debian.org>2021-10-01 23:06:08 +0200
committerMichael Biebl <biebl@debian.org>2021-10-01 23:06:08 +0200
commita3349a04ac4c38885cddefec8515c979d03f9327 (patch)
treed3bbee695aa048cb4ec252e7d63515c8376f9006 /src/libnm-core-intern/README.md
parent2d5b58e374d67f60880c7689e80c7745aeef3f62 (diff)
parente74c568b07b50b97873fb4ee1d776dedefbd54d6 (diff)
Update upstream source from tag 'upstream/1.32.12'
Update to upstream version '1.32.12'
with Debian dir 6fabefa95c7dcf83371a78eb2c47013a81ff8d86
Diffstat (limited to 'src/libnm-core-intern/README.md')
-rw-r--r--src/libnm-core-intern/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/src/libnm-core-intern/README.md b/src/libnm-core-intern/README.md
new file mode 100644
index 00000000..f17cf4da
--- /dev/null
+++ b/src/libnm-core-intern/README.md
@@ -0,0 +1,19 @@
+libnm-core-intern
+=================
+
+This contains header files only, which are also part of
+the internal API of [`libnm-core-impl`](../libnm-core-impl).
+
+[`libnm-core-impl`](../libnm-core-impl) is a static library that (among others) implements
+[`libnm-core-public`](../libnm-core-public) (which is a part of the public API of [`libnm`](../../libnm)).
+This library gets statically linked into [`libnm`](../../libnm) and `NetworkManager`.
+Hence, those components can also access internal (but not private) API of
+[`libnm-core-impl`](../libnm-core-impl), and this API is in [`libnm-core-intern`](../libnm-core-intern).
+
+These headers can thus be included by anybody who statically links with
+[`libnm-core-impl`](../libnm-core-impl) (including [`libnm-core-impl`](../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.