fdo-mirrors/NetworkManager
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git synced 2026-05-05 06:28:05 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

libnm: add code comment in "gen-metadata-nm-settings-libnm-core.xml"

Browse source
This commit is contained in:
Thomas Haller 2022-11-04 15:03:24 +01:00
parent 4f4f9807a4
commit 7d9f65ebc4
No known key found for this signature in database
GPG key ID: 29C2366E4DFC5728
2 changed files with 61 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
src/libnm-core-impl/gen-metadata-nm-settings-libnm-core.c
View file

@ -37,6 +37,37 @@ main(int argc, char *argv[])
const NMSettInfoSetting *sett_info_settings = nmtst_sett_info_settings();
NMMetaSettingType meta_type;
g_print("<!--\n"
" This file is generated.\n"
"\n"
" This XML contains meta data of NetworkManager connection profiles.\n"
"\n"
" NetworkManager's connection profiles are a bunch of settings, and this\n"
" contains the known properties. See also `man nm-settings-{dbus,nmcli,keyfile}`.\n"
"\n"
" Note that there are different manifestations of these properties. We have them\n"
" on the D-Bus API (`man nm-settings-dbus`), in keyfile format (`man "
"nm-settings-keyfile`)\n"
" in libnm's NMConnection and NMSetting API, and in nmcli (`man nm-settings-nmcli`).\n"
" There are similarities between these, but also subtle differencs. For example,\n"
" a property might not be shown in nmcli, or a property might be named different\n"
" on D-Bus or keyfile. Also, the data types may differ due to the differences of the\n"
" technology.\n"
"\n"
" This list of properties is not directly the properties as they are in any of\n"
" those manifestations. Instead, it's a general idea that this property exists in\n"
" NetworkManager. Whether and how it is represented in nmcli or keyfile, may differ.\n"
" The XML however aims to provide information for various backends.\n"
"\n"
" Attributes:\n"
" \"name\": the name of the property.\n"
" \"is-deprecated\": whether this property is deprecated.\n"
" \"dbus-type\": if this property is exposed on D-Bus. In that case, this\n"
" is the D-Bus type format. Also, \"name\" is the actual name of the field\n"
" \"dbus-deprecated\": if this property is on D-Bus and that representation is\n"
" deprecated. This usually means, that there is a replacement D-Bus property\n"
" that should be used instead.\n"
" -->\n");
g_print("<nm-setting-docs>\n");
for (meta_type = 0; meta_type < _NM_META_SETTING_TYPE_NUM; meta_type++) {
const NMSettInfoSetting *sis = &sett_info_settings[meta_type];

30
src/libnm-core-impl/gen-metadata-nm-settings-libnm-core.xml.in
View file

@ -1,3 +1,33 @@
<!--
This file is generated.
This XML contains meta data of NetworkManager connection profiles.
NetworkManager's connection profiles are a bunch of settings, and this
contains the known properties. See also `man nm-settings-{dbus,nmcli,keyfile}`.
Note that there are different manifestations of these properties. We have them
on the D-Bus API (`man nm-settings-dbus`), in keyfile format (`man nm-settings-keyfile`)
in libnm's NMConnection and NMSetting API, and in nmcli (`man nm-settings-nmcli`).
There are similarities between these, but also subtle differencs. For example,
a property might not be shown in nmcli, or a property might be named different
on D-Bus or keyfile. Also, the data types may differ due to the differences of the
technology.
This list of properties is not directly the properties as they are in any of
those manifestations. Instead, it's a general idea that this property exists in
NetworkManager. Whether and how it is represented in nmcli or keyfile, may differ.
The XML however aims to provide information for various backends.
Attributes:
"name": the name of the property.
"is-deprecated": whether this property is deprecated.
"dbus-type": if this property is exposed on D-Bus. In that case, this
is the D-Bus type format. Also, "name" is the actual name of the field
"dbus-deprecated": if this property is on D-Bus and that representation is
deprecated. This usually means, that there is a replacement D-Bus property
that should be used instead.
-->
<nm-setting-docs>
<setting name="6lowpan" >
<property name="name"