mirror of
https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git
synced 2026-05-17 18:08:07 +02:00
8460040df1
Having to type manually all the accepted values in each property's documentation is very error prone: you can make typos and you will probably forget to always update them when new possible values are added. If the possible values are the variant of an enum, we can use the introspection data to get all the possible values for that enum and their descriptions. With that info, we can automatically generate the documentation with an always up to date list of accepted values. Also, for nmcli documentation we want to show the pretty nickname of each value because it's the more user friendly way for users to enter the data. C names like NM_IP_TUNNEL_MODE_IPIP have no value here so they mustn't be shown, and the pretty nickname "ipip" must be shown instead. With this commit, the special string "#EnumName:*" can be used in docs and it will be expanded to the complete list of accepted values. If the docs that are being generated are for nmcli, pretty nicknames will be used instead of C names. It is also desirable to show a description of what each value means in nmcli man pages. To do this, the special string "#EnumName:**" can be used. It will expand the same way than "#EnumName:*" in the "description" field of the property, but it will expand to a formatted list with all the values and their explanations in the "description-docbook" field. The "description-docbook" field is currently only used for the nm-settings-nmcli man page. To expand a single enum value in the proper format (i.e. using nicknames in nmcli docs), use the string "%ENUM_VALUE". However, this feature has an important limitation: it can only be used for man/nm-settings-*.5 files generation, and the expansion only happens in the special tagged comments (like ---nmcli---), not in the normal gtkdoc comments. There are 2 reasons: 1. Any other documentation, other than man/nm-settings-*.5, is generated directly with gtkdoc, that doesn't support this expansion feature. 2. The gtkdoc comment applies to everything, either nmcli or dbus, keyfile, etc. We can't format the expanded text in a proper way without knowing where it's going to be used. |
||
|---|---|---|
| .. | ||
| c-list | ||
| c-rbtree | ||
| c-siphash | ||
| c-stdaux | ||
| contrib | ||
| core | ||
| libnm-base | ||
| libnm-client-aux-extern | ||
| libnm-client-impl | ||
| libnm-client-public | ||
| libnm-client-test | ||
| libnm-core-aux-extern | ||
| libnm-core-aux-intern | ||
| libnm-core-impl | ||
| libnm-core-intern | ||
| libnm-core-public | ||
| libnm-crypto | ||
| libnm-glib-aux | ||
| libnm-lldp | ||
| libnm-log-core | ||
| libnm-log-null | ||
| libnm-platform | ||
| libnm-std-aux | ||
| libnm-systemd-core | ||
| libnm-systemd-shared | ||
| libnm-udev-aux | ||
| libnmc-base | ||
| libnmc-setting | ||
| libnmt-newt | ||
| linux-headers | ||
| n-acd | ||
| n-dhcp4 | ||
| nm-cloud-setup | ||
| nm-compat-headers | ||
| nm-daemon-helper | ||
| nm-dispatcher | ||
| nm-initrd-generator | ||
| nm-online | ||
| nm-priv-helper | ||
| nmcli | ||
| nmtui | ||
| tests | ||
| meson.build | ||
| README.md | ||
src/
Most of the subdirectories are static helper libraries, which get linked into one of the final build artifacts (like libnm, nmcli or NetworkManager). Static libraries are internal API.
The only public API is libnm, which is a shared library provided client implementations.
Our own clients (like nmcli and nmtui) also use libnm, the shared library. But they also use additional static helper libraries.
The daemon statically links against a part of libnm, the part that provides connection profiles. That is libnm-core. libnm-core is thus statically linked with libnm and the daemon. It does not get linked by clients that already link with libnm (like nmtui).
Read the individual README.md files in the subdirectories for details:
| Directory | Description |
|---|---|
| core/ | the NetworkManager daemon |
| nmcli/ | nmcli application, a command line client for NetworkManager |
| nmtui/ | nmtui application, a text UI client for NetworkManager |
| nm-cloud-setup/ | service to automatically configure NetworkManager in cloud environment |
| nm-initrd-generator/ | generates NetworkManager configuration by parsing kernel command line options for dracut/initrd |
| nm-dispatcher/ | NetworkManager-dispatcher service to run user scripts |
| nm-online/ | application which checks whether NetworkManager is done, for implementing NetworkManager-wait-online.service |
| nm-priv-helper/ | internal service for privileged operations |
| nm-daemon-helper/ | internal helper binary spawned by NetworkManager |
| libnm-std-aux/ | internal helper library for standard C |
| libnm-glib-aux/ | internal helper library for glib |
| libnm-log-null/ | internal helper library with dummy (null) logging backend |
| libnm-log-core/ | internal helper library with logging backend (syslog) used by daemon |
| libnm-base/ | internal helper library with base definitions |
| libnm-platform/ | internal helper library for netlink and other platform/kernel API |
| libnm-udev-aux/ | internal helper library for libudev |
| libnm-core-public/ | public API of libnm (libnm-core part) |
| libnm-core-intern/ | internal API of libnm-core, used by libnm and daemon |
| libnm-core-impl/ | implementation of libnm-core |
| libnm-core-aux-intern/ | internal helper library on top of libnm-core (used by libnm-core itself) |
| libnm-core-aux-extern/ | internal helper library on top of libnm-core (not used by libnm-core) |
| libnm-client-public/ | public API of libnm (NMClient part) |
| libnm-client-impl/ | implementation of libnm (NMClient) |
| libnm-client-aux-extern/ | internal helper library on top of libnm (not used by libnm itself) |
| libnmc-base/ | internal helper library for libnm clients |
| libnmc-setting/ | internal helper library for setting connection profiles (used by nmcli) |
| libnmt-newt/ | internal helper library for libnewt for nmtui |
| linux-headers/ | extra Linux kernel UAPI headers |
| contrib/ | sources that are not used by NetworkManager itself |
| tests/ | unit tests that are not specific to one of the other directories |
| libnm-client-test/ | internal helper library with test utils for libnm |
| c-list/ | fork of c-util helper library for intrusive, doubly linked list |
| c-rbtree/ | fork of c-util helper library for intrusive Red-Black Tree |
| c-siphash/ | fork of c-util helper library for SIPHash24 |
| c-stdaux/ | fork of c-util general purpose helpers for standard C |
| n-acd/ | fork of nettools IPv4 ACD library |
| n-dhcp4/ | fork of nettools DHCPv4 library |
| libnm-systemd-core/ | fork of systemd code as network library |
| libnm-systemd-shared/ | fork of systemd code as general purpose library |