about summary refs log tree commit diff
path: root/src/libnm-core-intern/README.md
diff options
context:
space:
mode:
authorSebastien Bacher <seb128@ubuntu.com>2021-07-05 20:36:07 +0200
committerSebastien Bacher <seb128@ubuntu.com>2021-07-05 20:36:07 +0200
commit5d67593e4f1329fc32a36adc5dbc445e7c606bd1 (patch)
tree5f470f020ca8f1240ddc29b11912fee174f5d68c /src/libnm-core-intern/README.md
parent9996e637dc976a77c36f07c6debb737f9a5df0b7 (diff)
parent35779c6675728fa6f0fd0a21cefb904408509c23 (diff)
Update upstream source from tag 'upstream/1.32.2'
Update to upstream version '1.32.2'
with Debian dir db5d9d9657d75d750d835860e38c6af24cc54472
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.