about summary refs log tree commit diff
path: root/src/libnm-core-impl/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-impl/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-impl/README.md')
-rw-r--r--src/libnm-core-impl/README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/src/libnm-core-impl/README.md b/src/libnm-core-impl/README.md
new file mode 100644
index 00000000..0fce8e1e
--- /dev/null
+++ b/src/libnm-core-impl/README.md
@@ -0,0 +1,22 @@
+libnm-core-impl
+===============
+
+NetworkManager provides a client library [`libnm`](../../libnm).
+NetworkManager core does not (dynamically) link against all of libnm.
+Instead, it statically links against a part of it.
+That part is the static helper library `libnm-core-impl`.
+
+`libnm-core-impl` implements (and provides) the API from
+[`libnm-core-public`](../libnm-core-public), which is part of the public
+API of [`libnm`](../../libnm). In this form, `libnm-core-impl` is part
+of the implementation of [`libnm`](../../libnm). It also implements (and
+provides) an internal API [`libnm-core-intern`](../libnm-core-intern) which
+can only be used by those who link statically against `libnm-core-impl`.
+
+Only NetworkManager core and [`libnm`](../../libnm) are allowed to statically
+link with `libnm-core-impl`. Consequently, only those are allowed to include
+[`libnm-core-intern`](../libnm-core-intern).
+
+This directory should not be added to the include search path of other
+components as they are only allowed to include [`libnm-core-public`](../libnm-core-public)
+and [`libnm-core-intern`](../libnm-core-intern).