diff options
Diffstat (limited to 'src/libnm-platform/README.md')
| -rw-r--r-- | src/libnm-platform/README.md | 22 |
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/) |