about summary refs log tree commit diff
path: root/src/libnm-platform/README.md
diff options
context:
space:
mode:
authorMichael Biebl <biebl@debian.org>2024-05-05 00:07:42 +0200
committerMichael Biebl <biebl@debian.org>2024-05-05 00:07:42 +0200
commita9c892f6640668b93848584d246280c4d33cc025 (patch)
tree914226b8c8fffd1a8e101e71d361d6d126322c12 /src/libnm-platform/README.md
parentf03946fe0cdd73041658be1009f06f0e287c4b80 (diff)
parent34bb501be08aa2b313d88e67d6e0a7e0a3f9cfa6 (diff)
Update upstream source from tag 'upstream/1.47.90'
Update to upstream version '1.47.90'
with Debian dir fca683c43690f5e2bfc191d3d528666444bec54b
Diffstat (limited to 'src/libnm-platform/README.md')
-rw-r--r--src/libnm-platform/README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/src/libnm-platform/README.md b/src/libnm-platform/README.md
new file mode 100644
index 00000000..c8e7cf76
--- /dev/null
+++ b/src/libnm-platform/README.md
@@ -0,0 +1,22 @@
+libnm-platform
+==============
+
+A static helper library that provides `NMPlatform` and other utils.
+This is NetworkManager's internal netlink library, but also contains
+helpers for sysfs, ethtool and other kernel APIs.
+
+`NMPlaform` is also a cache of objects of the netlink API: `NMPCache`
+and `NMPObject`. These objects are used throughout NetworkManager
+also for generally tracking information about these types. For example,
+`NMPlatformIP4Address` (the public part of a certain type of `NMPObject`)
+is not only used to track platform addresses from netlink in the cache,
+but to track information about IPv4 addresses in general.
+
+This depends on the following helper libraries
+
+  - [../libnm-std-aux/](../libnm-std-aux/)
+  - [../libnm-base/](../libnm-base/)
+  - [../libnm-glib-aux/](../libnm-glib-aux/)
+  - [../libnm-udev-aux/](../libnm-udev-aux/)
+  - [../libnm-log-core/](../libnm-log-core/)
+  - [../linux-headers/](../linux-headers/)