colin/NetworkManager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

libnm: merge branch 'th/libnm-doc-annotation-fixes'

Browse Source 
https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/merge_requests/1352
This commit is contained in:
Thomas Haller
2022-09-02 19:04:05 +02:00
parent f3327835c1 18eeb4bf6c
commit fde772643c
11 changed files with 52 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
src/libnm-core-impl/nm-setting-8021x.c
View File

@@ -3296,9 +3296,6 @@ nm_setting_802_1x_class_init(NMSetting8021xClass *klass)
* *
* Since: 1.8 * Since: 1.8
**/ **/
/* ---ifcfg-rh---
* ---end---
*/
_nm_setting_property_define_direct_string(properties_override, _nm_setting_property_define_direct_string(properties_override,
obj_properties, obj_properties,
NM_SETTING_802_1X_CA_CERT_PASSWORD, NM_SETTING_802_1X_CA_CERT_PASSWORD,
@@ -3314,9 +3311,6 @@ nm_setting_802_1x_class_init(NMSetting8021xClass *klass)
* *
* Since: 1.8 * Since: 1.8
**/ **/
/* ---ifcfg-rh---
* ---end---
*/
_nm_setting_property_define_direct_secret_flags(properties_override, _nm_setting_property_define_direct_secret_flags(properties_override,
obj_properties, obj_properties,
NM_SETTING_802_1X_CA_CERT_PASSWORD_FLAGS, NM_SETTING_802_1X_CA_CERT_PASSWORD_FLAGS,
@@ -3486,9 +3480,6 @@ nm_setting_802_1x_class_init(NMSetting8021xClass *klass)
* *
* Since: 1.8 * Since: 1.8
**/ **/
/* ---ifcfg-rh---
* ---end---
*/
_nm_setting_property_define_direct_string(properties_override, _nm_setting_property_define_direct_string(properties_override,
obj_properties, obj_properties,
NM_SETTING_802_1X_CLIENT_CERT_PASSWORD, NM_SETTING_802_1X_CLIENT_CERT_PASSWORD,
@@ -3504,9 +3495,6 @@ nm_setting_802_1x_class_init(NMSetting8021xClass *klass)
* *
* Since: 1.8 * Since: 1.8
**/ **/
/* ---ifcfg-rh---
* ---end---
*/
_nm_setting_property_define_direct_secret_flags(properties_override, _nm_setting_property_define_direct_secret_flags(properties_override,
obj_properties, obj_properties,
NM_SETTING_802_1X_CLIENT_CERT_PASSWORD_FLAGS, NM_SETTING_802_1X_CLIENT_CERT_PASSWORD_FLAGS,
@@ -3718,9 +3706,6 @@ nm_setting_802_1x_class_init(NMSetting8021xClass *klass)
* *
* Since: 1.8 * Since: 1.8
**/ **/
/* ---ifcfg-rh---
* ---end---
*/
_nm_setting_property_define_direct_string(properties_override, _nm_setting_property_define_direct_string(properties_override,
obj_properties, obj_properties,
NM_SETTING_802_1X_PHASE2_CA_CERT_PASSWORD, NM_SETTING_802_1X_PHASE2_CA_CERT_PASSWORD,
@@ -3736,9 +3721,6 @@ nm_setting_802_1x_class_init(NMSetting8021xClass *klass)
* *
* Since: 1.8 * Since: 1.8
**/ **/
/* ---ifcfg-rh---
* ---end---
*/
_nm_setting_property_define_direct_secret_flags(properties_override, _nm_setting_property_define_direct_secret_flags(properties_override,
obj_properties, obj_properties,
NM_SETTING_802_1X_PHASE2_CA_CERT_PASSWORD_FLAGS, NM_SETTING_802_1X_PHASE2_CA_CERT_PASSWORD_FLAGS,
@@ -3913,9 +3895,6 @@ nm_setting_802_1x_class_init(NMSetting8021xClass *klass)
* *
* Since: 1.8 * Since: 1.8
**/ **/
/* ---ifcfg-rh---
* ---end---
*/
_nm_setting_property_define_direct_string(properties_override, _nm_setting_property_define_direct_string(properties_override,
obj_properties, obj_properties,
NM_SETTING_802_1X_PHASE2_CLIENT_CERT_PASSWORD, NM_SETTING_802_1X_PHASE2_CLIENT_CERT_PASSWORD,
@@ -3931,9 +3910,6 @@ nm_setting_802_1x_class_init(NMSetting8021xClass *klass)
* *
* Since: 1.8 * Since: 1.8
**/ **/
/* ---ifcfg-rh---
* ---end---
*/
_nm_setting_property_define_direct_secret_flags( _nm_setting_property_define_direct_secret_flags(
properties_override, properties_override,
obj_properties, obj_properties,

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 * example: mac-address=00:22:68:12:79:A2
* mac-address=0;34;104;18;121;162; * mac-address=0;34;104;18;121;162;
* ---end--- * ---end---
* ---ifcfg-rh--- */
/* ---ifcfg-rh---
* property: mac-address * property: mac-address
* variable: BRIDGE_MACADDR(+) * variable: BRIDGE_MACADDR(+)
* description: MAC address of the bridge. Note that this requires a recent * description: MAC address of the bridge. Note that this requires a recent

2
src/libnm-core-impl/nm-setting-hostname.c
View File

@@ -233,7 +233,7 @@ nm_setting_hostname_class_init(NMSettingHostnameClass *klass)
* Since: 1.30 * Since: 1.30
**/ **/
/* ---ifcfg-rh--- /* ---ifcfg-rh---
* property: from-dhcp * property: from-dns-lookup
* variable: HOSTNAME_FROM_DNS_LOOKUP(+) * variable: HOSTNAME_FROM_DNS_LOOKUP(+)
* default: missing variable means global default or 1 * default: missing variable means global default or 1
* description: whether the system hostname can be determined from reverse * description: whether the system hostname can be determined from reverse

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) * 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 * example: mac-address= 80:00:00:6d:fe:80:00:00:00:00:00:00:00:02:55:00:70:33:cf:01
* ---end--- * ---end---
* ---ifcfg-rh--- */
/* ---ifcfg-rh---
* property: mac-address * property: mac-address
* variable: HWADDR * variable: HWADDR
* description: IBoIP 20-byte hardware address of the device (in traditional * description: IBoIP 20-byte hardware address of the device (in traditional

13
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. * description: List of DNS servers.
* example: dns=1.2.3.4;8.8.8.8;8.8.4.4; * example: dns=1.2.3.4;8.8.8.8;8.8.4.4;
* ---end--- * ---end---
* ---ifcfg-rh--- */
/* ---ifcfg-rh---
* property: dns * property: dns
* variable: DNS1, DNS2, ... * variable: DNS1, DNS2, ...
* format: string * format: string
@@ -662,7 +663,8 @@ nm_setting_ip4_config_class_init(NMSettingIP4ConfigClass *klass)
* description: List of static IP addresses. * description: List of static IP addresses.
* example: address1=192.168.100.100/24 address2=10.1.1.5/24 * example: address1=192.168.100.100/24 address2=10.1.1.5/24
* ---end--- * ---end---
* ---ifcfg-rh--- */
/* ---ifcfg-rh---
* property: addresses * property: addresses
* variable: IPADDR, PREFIX (NETMASK), IPADDR1, PREFIX1 (NETMASK1), ... * variable: IPADDR, PREFIX (NETMASK), IPADDR1, PREFIX1 (NETMASK1), ...
* description: List of static IP addresses. * 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. * description: Gateway IP addresses as a string.
* example: gateway=192.168.100.1 * example: gateway=192.168.100.1
* ---end--- * ---end---
* ---ifcfg-rh--- */
/* ---ifcfg-rh---
* property: gateway * property: gateway
* variable: GATEWAY * variable: GATEWAY
* description: Gateway IP address. * 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 * example: route1=8.8.8.0/24,10.1.1.1,77
* route2=7.7.0.0/16 * route2=7.7.0.0/16
* ---end--- * ---end---
* ---ifcfg-rh--- */
/* ---ifcfg-rh---
* property: routes * property: routes
* variable: ADDRESS1, NETMASK1, GATEWAY1, METRIC1, OPTIONS1, ... * variable: ADDRESS1, NETMASK1, GATEWAY1, METRIC1, OPTIONS1, ...
* description: List of static routes. They are not stored in ifcfg-* file, * description: List of static routes. They are not stored in ifcfg-* file,
@@ -860,6 +864,7 @@ nm_setting_ip4_config_class_init(NMSettingIP4ConfigClass *klass)
* variable: DHCP_HOSTNAME_FLAGS * variable: DHCP_HOSTNAME_FLAGS
* description: flags for the DHCP hostname and FQDN properties * description: flags for the DHCP hostname and FQDN properties
* example: DHCP_HOSTNAME_FLAGS=5 * example: DHCP_HOSTNAME_FLAGS=5
* ---end---
*/ */
/** /**

14
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. * description: List of DNS servers.
* example: dns=2001:4860:4860::8888;2001:4860:4860::8844; * example: dns=2001:4860:4860::8888;2001:4860:4860::8844;
* ---end--- * ---end---
* ---ifcfg-rh--- */
/* ---ifcfg-rh---
* property: dns * property: dns
* variable: DNS1, DNS2, ... * variable: DNS1, DNS2, ...
* format: string * format: string
@@ -600,7 +601,8 @@ nm_setting_ip6_config_class_init(NMSettingIP6ConfigClass *klass)
* description: List of static IP addresses. * description: List of static IP addresses.
* example: address1=abbe::cafe/96 address2=2001::1234 * example: address1=abbe::cafe/96 address2=2001::1234
* ---end--- * ---end---
* ---ifcfg-rh--- */
/* ---ifcfg-rh---
* property: addresses * property: addresses
* variable: IPV6ADDR, IPV6ADDR_SECONDARIES * variable: IPV6ADDR, IPV6ADDR_SECONDARIES
* description: List of static IP addresses. * 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. * description: Gateway IP addresses as a string.
* example: gateway=abbe::1 * example: gateway=abbe::1
* ---end--- * ---end---
* ---ifcfg-rh--- */
/* ---ifcfg-rh---
* property: gateway * property: gateway
* variable: IPV6_DEFAULTGW * variable: IPV6_DEFAULTGW
* description: Gateway IP address. * description: Gateway IP address.
@@ -631,7 +634,8 @@ nm_setting_ip6_config_class_init(NMSettingIP6ConfigClass *klass)
* description: List of IP routes. * description: List of IP routes.
* example: route1=2001:4860:4860::/64,2620:52:0:2219:222:68ff:fe11:5403 * example: route1=2001:4860:4860::/64,2620:52:0:2219:222:68ff:fe11:5403
* ---end--- * ---end---
* ---ifcfg-rh--- */
/* ---ifcfg-rh---
* property: routes * property: routes
* variable: (none) * variable: (none)
* description: List of static routes. They are not stored in ifcfg-* file, * description: List of static routes. They are not stored in ifcfg-* file,
@@ -870,7 +874,7 @@ nm_setting_ip6_config_class_init(NMSettingIP6ConfigClass *klass)
* Since: 1.24 * Since: 1.24
**/ **/
/* ---ifcfg-rh--- /* ---ifcfg-rh---
* property: dhcp-timeout * property: ra-timeout
* variable: IPV6_RA_TIMEOUT(+) * variable: IPV6_RA_TIMEOUT(+)
* description: A timeout for waiting Router Advertisements in seconds. * description: A timeout for waiting Router Advertisements in seconds.
* example: IPV6_RA_TIMEOUT=10 * example: IPV6_RA_TIMEOUT=10

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. * 111 ('o') for odd, or 110 ('n') for none.
* example: parity=n * example: parity=n
* ---end--- * ---end---
* ---dbus--- */
/* ---dbus---
* property: parity * property: parity
* format: byte * format: byte
* description: The connection parity: 69 (ASCII 'E') for even parity, * description: The connection parity: 69 (ASCII 'E') for even parity,

10
src/libnm-core-impl/nm-setting-tc-config.c
View File

@@ -1944,8 +1944,8 @@ nm_setting_tc_config_class_init(NMSettingTCConfigClass *klass)
* <para> * <para>
* can be used to set a different hash table size, available * can be used to set a different hash table size, available
* from kernel 2.6.39 onwards. The specified divisor must be * from kernel 2.6.39 onwards. The specified divisor must be
* a power of two and cannot be larger than 65536. Default * a power of two and cannot be larger than 65536.
* value: 1024. * Default value: 1024.
* </para> * </para>
* </listitem> * </listitem>
* </varlistentry> * </varlistentry>
@@ -2107,8 +2107,8 @@ nm_setting_tc_config_class_init(NMSettingTCConfigClass *klass)
* format: GPtrArray(NMTCTfilter) * format: GPtrArray(NMTCTfilter)
* description-docbook: * description-docbook:
* <para> * <para>
* Array of TC traffic filters. Traffic control can manage the packet content during * Array of TC traffic filters. Traffic control can manage the packet content during
* classification by using filters. * classification by using filters.
* </para> * </para>
* <para> * <para>
* Each tfilters can be specified by the following attributes: * Each tfilters can be specified by the following attributes:
@@ -2206,7 +2206,7 @@ nm_setting_tc_config_class_init(NMSettingTCConfigClass *klass)
* ---end--- * ---end---
**/ **/
/* ---ifcfg-rh--- /* ---ifcfg-rh---
* property: qdiscs * property: tfilters
* variable: FILTER1(+), FILTER2(+), ..., TC_COMMIT(+) * variable: FILTER1(+), FILTER2(+), ..., TC_COMMIT(+)
* description: Traffic filters to set on the interface. When no * description: Traffic filters to set on the interface. When no
* QDISC1, QDISC2, ..., FILTER1, FILTER2, ... keys are present, * QDISC1, QDISC2, ..., FILTER1, FILTER2, ... keys are present,

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. * but VLAN id from DEVICE takes precedence over VLAN_ID.
* example: PHYSDEV=eth0, VLAN_ID=12; or DEVICE=eth0.12 * example: PHYSDEV=eth0, VLAN_ID=12; or DEVICE=eth0.12
* ---end--- * ---end---
* ---dbus--- */
/* ---dbus---
* property: interface-name * property: interface-name
* format: string * format: string
* description: Deprecated in favor of connection.interface-name, but can * 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. 00:22:68:12:79:A2), or semicolon separated list of 6 bytes (obsolete)
* (e.g. 0;34;104;18;121;162) * (e.g. 0;34;104;18;121;162)
* ---end--- * ---end---
* ---ifcfg-rh--- */
/* ---ifcfg-rh---
* property: mac-address * property: mac-address
* variable: HWADDR * variable: HWADDR
* description: Hardware address of the device in traditional hex-digits-and-colons * 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. 00:22:68:12:79:B2), or semicolon separated list of 6 bytes (obsolete)
* (e.g. 0;34;104;18;121;178). * (e.g. 0;34;104;18;121;178).
* ---end--- * ---end---
* ---ifcfg-rh--- */
/* ---ifcfg-rh---
* property: cloned-mac-address * property: cloned-mac-address
* variable: MACADDR * variable: MACADDR
* description: Cloned (spoofed) MAC address in traditional hex-digits-and-colons * description: Cloned (spoofed) MAC address in traditional hex-digits-and-colons
* notation (e.g. 00:22:68:14:5A:99). * notation (e.g. 00:22:68:14:5A:99).
* ---end--- * ---end---
* ---dbus--- */
/* ---dbus---
* property: cloned-mac-address * property: cloned-mac-address
* format: byte array * format: byte array
* description: This D-Bus field is deprecated in favor of "assigned-mac-address" * 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. * description: MAC address blacklist.
* example: mac-address-blacklist= 00:22:68:12:79:A6;00:22:68:12:79:78 * example: mac-address-blacklist= 00:22:68:12:79:A6;00:22:68:12:79:78
* ---end--- * ---end---
* ---ifcfg-rh--- */
/* ---ifcfg-rh---
* property: mac-address-blacklist * property: mac-address-blacklist
* variable: HWADDR_BLACKLIST(+) * variable: HWADDR_BLACKLIST(+)
* description: It denies usage of the connection for any device whose address * 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. * description: SSID of Wi-Fi network.
* example: ssid=Quick Net * example: ssid=Quick Net
* ---end--- * ---end---
* ---ifcfg-rh--- */
/* ---ifcfg-rh---
* property: ssid * property: ssid
* variable: ESSID * variable: ESSID
* description: SSID of Wi-Fi network. * 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. 00:22:68:12:79:A2), or semicolon separated list of 6 bytes (obsolete)
* (e.g. 0;34;104;18;121;162). * (e.g. 0;34;104;18;121;162).
* ---end--- * ---end---
* ---ifcfg-rh--- */
/* ---ifcfg-rh---
* property: mac-address * property: mac-address
* variable: HWADDR * variable: HWADDR
* description: Hardware address of the device in traditional hex-digits-and-colons * 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. 00:22:68:12:79:B2), or semicolon separated list of 6 bytes (obsolete)
* (e.g. 0;34;104;18;121;178). * (e.g. 0;34;104;18;121;178).
* ---end--- * ---end---
* ---ifcfg-rh--- */
/* ---ifcfg-rh---
* property: cloned-mac-address * property: cloned-mac-address
* variable: MACADDR * variable: MACADDR
* description: Cloned (spoofed) MAC address in traditional hex-digits-and-colons * description: Cloned (spoofed) MAC address in traditional hex-digits-and-colons
* notation (e.g. 00:22:68:14:5A:99). * notation (e.g. 00:22:68:14:5A:99).
* ---end--- * ---end---
* ---dbus--- */
/* ---dbus---
* property: cloned-mac-address * property: cloned-mac-address
* format: byte array * format: byte array
* description: This D-Bus field is deprecated in favor of "assigned-mac-address" * 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. * description: MAC address blacklist.
* example: mac-address-blacklist= 00:22:68:12:79:A6;00:22:68:12:79:78 * example: mac-address-blacklist= 00:22:68:12:79:A6;00:22:68:12:79:78
* ---end--- * ---end---
* ---ifcfg-rh--- */
/* ---ifcfg-rh---
* property: mac-address-blacklist * property: mac-address-blacklist
* variable: HWADDR_BLACKLIST(+) * variable: HWADDR_BLACKLIST(+)
* description: It denies usage of the connection for any device whose address * 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) * variable: (none)
* description: This property is deprecated and not handled by ifcfg-rh-plugin. * description: This property is deprecated and not handled by ifcfg-rh-plugin.
* ---end--- * ---end---
* ---dbus--- */
/* ---dbus---
* property: security * property: security
* description: This property is deprecated, but can be set to the value * description: This property is deprecated, but can be set to the value
* '802-11-wireless-security' when a wireless security setting is also * '802-11-wireless-security' when a wireless security setting is also