fdo-mirrors/NetworkManager
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git synced 2025-12-25 03:40:07 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

libnm: style cleanups for property annotations

Browse source 
The parser will become stricter, and expect certain
things. The strictness should help, to avoid writing wrong annotations.

Adjust for that.
This commit is contained in:
Thomas Haller 2022-08-29 15:05:39 +02:00
parent e70607aa55
commit 2ccbf8af3b
No known key found for this signature in database
GPG key ID: 29C2366E4DFC5728
9 changed files with 46 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
src/libnm-core-impl/nm-setting-bridge.c
View file

@ -1439,7 +1439,8 @@ nm_setting_bridge_class_init(NMSettingBridgeClass *klass)
* example: mac-address=00:22:68:12:79:A2
* mac-address=0;34;104;18;121;162;
* ---end---
* ---ifcfg-rh---
*/
/* ---ifcfg-rh---
* property: mac-address
* variable: BRIDGE_MACADDR(+)
* description: MAC address of the bridge. Note that this requires a recent

3
src/libnm-core-impl/nm-setting-infiniband.c
View file

@ -378,7 +378,8 @@ nm_setting_infiniband_class_init(NMSettingInfinibandClass *klass)
* or semicolon separated list of 20 decimal bytes (obsolete)
* example: mac-address= 80:00:00:6d:fe:80:00:00:00:00:00:00:00:02:55:00:70:33:cf:01
* ---end---
* ---ifcfg-rh---
*/
/* ---ifcfg-rh---
* property: mac-address
* variable: HWADDR
* description: IBoIP 20-byte hardware address of the device (in traditional

12
src/libnm-core-impl/nm-setting-ip4-config.c
View file

@ -637,7 +637,8 @@ nm_setting_ip4_config_class_init(NMSettingIP4ConfigClass *klass)
* description: List of DNS servers.
* example: dns=1.2.3.4;8.8.8.8;8.8.4.4;
* ---end---
* ---ifcfg-rh---
*/
/* ---ifcfg-rh---
* property: dns
* variable: DNS1, DNS2, ...
* format: string
@ -662,7 +663,8 @@ nm_setting_ip4_config_class_init(NMSettingIP4ConfigClass *klass)
* description: List of static IP addresses.
* example: address1=192.168.100.100/24 address2=10.1.1.5/24
* ---end---
* ---ifcfg-rh---
*/
/* ---ifcfg-rh---
* property: addresses
* variable: IPADDR, PREFIX (NETMASK), IPADDR1, PREFIX1 (NETMASK1), ...
* description: List of static IP addresses.
@ -677,7 +679,8 @@ nm_setting_ip4_config_class_init(NMSettingIP4ConfigClass *klass)
* description: Gateway IP addresses as a string.
* example: gateway=192.168.100.1
* ---end---
* ---ifcfg-rh---
*/
/* ---ifcfg-rh---
* property: gateway
* variable: GATEWAY
* description: Gateway IP address.
@ -693,7 +696,8 @@ nm_setting_ip4_config_class_init(NMSettingIP4ConfigClass *klass)
* example: route1=8.8.8.0/24,10.1.1.1,77
* route2=7.7.0.0/16
* ---end---
* ---ifcfg-rh---
*/
/* ---ifcfg-rh---
* property: routes
* variable: ADDRESS1, NETMASK1, GATEWAY1, METRIC1, OPTIONS1, ...
* description: List of static routes. They are not stored in ifcfg-* file,

12
src/libnm-core-impl/nm-setting-ip6-config.c
View file

@ -576,7 +576,8 @@ nm_setting_ip6_config_class_init(NMSettingIP6ConfigClass *klass)
* description: List of DNS servers.
* example: dns=2001:4860:4860::8888;2001:4860:4860::8844;
* ---end---
* ---ifcfg-rh---
*/
/* ---ifcfg-rh---
* property: dns
* variable: DNS1, DNS2, ...
* format: string
@ -600,7 +601,8 @@ nm_setting_ip6_config_class_init(NMSettingIP6ConfigClass *klass)
* description: List of static IP addresses.
* example: address1=abbe::cafe/96 address2=2001::1234
* ---end---
* ---ifcfg-rh---
*/
/* ---ifcfg-rh---
* property: addresses
* variable: IPV6ADDR, IPV6ADDR_SECONDARIES
* description: List of static IP addresses.
@ -616,7 +618,8 @@ nm_setting_ip6_config_class_init(NMSettingIP6ConfigClass *klass)
* description: Gateway IP addresses as a string.
* example: gateway=abbe::1
* ---end---
* ---ifcfg-rh---
*/
/* ---ifcfg-rh---
* property: gateway
* variable: IPV6_DEFAULTGW
* description: Gateway IP address.
@ -631,7 +634,8 @@ nm_setting_ip6_config_class_init(NMSettingIP6ConfigClass *klass)
* description: List of IP routes.
* example: route1=2001:4860:4860::/64,2620:52:0:2219:222:68ff:fe11:5403
* ---end---
* ---ifcfg-rh---
*/
/* ---ifcfg-rh---
* property: routes
* variable: (none)
* description: List of static routes. They are not stored in ifcfg-* file,

3
src/libnm-core-impl/nm-setting-serial.c
View file

@ -278,7 +278,8 @@ nm_setting_serial_class_init(NMSettingSerialClass *klass)
* 111 ('o') for odd, or 110 ('n') for none.
* example: parity=n
* ---end---
* ---dbus---
*/
/* ---dbus---
* property: parity
* format: byte
* description: The connection parity: 69 (ASCII 'E') for even parity,

4
src/libnm-core-impl/nm-setting-tc-config.c
View file

@ -2107,8 +2107,8 @@ nm_setting_tc_config_class_init(NMSettingTCConfigClass *klass)
* format: GPtrArray(NMTCTfilter)
* description-docbook:
* <para>
* Array of TC traffic filters. Traffic control can manage the packet content during
* classification by using filters.
* Array of TC traffic filters. Traffic control can manage the packet content during
* classification by using filters.
* </para>
* <para>
* Each tfilters can be specified by the following attributes:

3
src/libnm-core-impl/nm-setting-vlan.c
View file

@ -965,7 +965,8 @@ nm_setting_vlan_class_init(NMSettingVlanClass *klass)
* but VLAN id from DEVICE takes precedence over VLAN_ID.
* example: PHYSDEV=eth0, VLAN_ID=12; or DEVICE=eth0.12
* ---end---
* ---dbus---
*/
/* ---dbus---
* property: interface-name
* format: string
* description: Deprecated in favor of connection.interface-name, but can

12
src/libnm-core-impl/nm-setting-wired.c
View file

@ -1311,7 +1311,8 @@ nm_setting_wired_class_init(NMSettingWiredClass *klass)
* (e.g. 00:22:68:12:79:A2), or semicolon separated list of 6 bytes (obsolete)
* (e.g. 0;34;104;18;121;162)
* ---end---
* ---ifcfg-rh---
*/
/* ---ifcfg-rh---
* property: mac-address
* variable: HWADDR
* description: Hardware address of the device in traditional hex-digits-and-colons
@ -1359,13 +1360,15 @@ nm_setting_wired_class_init(NMSettingWiredClass *klass)
* (e.g. 00:22:68:12:79:B2), or semicolon separated list of 6 bytes (obsolete)
* (e.g. 0;34;104;18;121;178).
* ---end---
* ---ifcfg-rh---
*/
/* ---ifcfg-rh---
* property: cloned-mac-address
* variable: MACADDR
* description: Cloned (spoofed) MAC address in traditional hex-digits-and-colons
* notation (e.g. 00:22:68:14:5A:99).
* ---end---
* ---dbus---
*/
/* ---dbus---
* property: cloned-mac-address
* format: byte array
* description: This D-Bus field is deprecated in favor of "assigned-mac-address"
@ -1465,7 +1468,8 @@ nm_setting_wired_class_init(NMSettingWiredClass *klass)
* description: MAC address blacklist.
* example: mac-address-blacklist= 00:22:68:12:79:A6;00:22:68:12:79:78
* ---end---
* ---ifcfg-rh---
*/
/* ---ifcfg-rh---
* property: mac-address-blacklist
* variable: HWADDR_BLACKLIST(+)
* description: It denies usage of the connection for any device whose address

18
src/libnm-core-impl/nm-setting-wireless.c
View file

@ -1311,7 +1311,8 @@ nm_setting_wireless_class_init(NMSettingWirelessClass *klass)
* description: SSID of Wi-Fi network.
* example: ssid=Quick Net
* ---end---
* ---ifcfg-rh---
*/
/* ---ifcfg-rh---
* property: ssid
* variable: ESSID
* description: SSID of Wi-Fi network.
@ -1493,7 +1494,8 @@ nm_setting_wireless_class_init(NMSettingWirelessClass *klass)
* (e.g. 00:22:68:12:79:A2), or semicolon separated list of 6 bytes (obsolete)
* (e.g. 0;34;104;18;121;162).
* ---end---
* ---ifcfg-rh---
*/
/* ---ifcfg-rh---
* property: mac-address
* variable: HWADDR
* description: Hardware address of the device in traditional hex-digits-and-colons
@ -1540,13 +1542,15 @@ nm_setting_wireless_class_init(NMSettingWirelessClass *klass)
* (e.g. 00:22:68:12:79:B2), or semicolon separated list of 6 bytes (obsolete)
* (e.g. 0;34;104;18;121;178).
* ---end---
* ---ifcfg-rh---
*/
/* ---ifcfg-rh---
* property: cloned-mac-address
* variable: MACADDR
* description: Cloned (spoofed) MAC address in traditional hex-digits-and-colons
* notation (e.g. 00:22:68:14:5A:99).
* ---end---
* ---dbus---
*/
/* ---dbus---
* property: cloned-mac-address
* format: byte array
* description: This D-Bus field is deprecated in favor of "assigned-mac-address"
@ -1645,7 +1649,8 @@ nm_setting_wireless_class_init(NMSettingWirelessClass *klass)
* description: MAC address blacklist.
* example: mac-address-blacklist= 00:22:68:12:79:A6;00:22:68:12:79:78
* ---end---
* ---ifcfg-rh---
*/
/* ---ifcfg-rh---
* property: mac-address-blacklist
* variable: HWADDR_BLACKLIST(+)
* description: It denies usage of the connection for any device whose address
@ -1813,7 +1818,8 @@ nm_setting_wireless_class_init(NMSettingWirelessClass *klass)
* variable: (none)
* description: This property is deprecated and not handled by ifcfg-rh-plugin.
* ---end---
* ---dbus---
*/
/* ---dbus---
* property: security
* description: This property is deprecated, but can be set to the value
* '802-11-wireless-security' when a wireless security setting is also