libnm-util: add ifcfg-rh specific description for propertiesjk/bgo683111-keyfile-ifcfg-rh-docs

as comments in libnm-util/nm-setting-*.c files
The comments are parsed by generate-plugin-docs.pl script.

1 files changed, 79 insertions, 0 deletions

diff --git a/libnm-util/nm-setting-wired.c b/libnm-util/nm-setting-wired.c
index 7e0aefe2b4..02cf7fbf32 100644
--- a/libnm-util/nm-setting-wired.c
+++ b/libnm-util/nm-setting-wired.c
@@ -872,6 +872,13 @@ nm_setting_wired_class_init (NMSettingWiredClass *setting_class)
 	 * Interface), "bnc" (Thin Ethernet) or "mii" (Media Independent Interface.
 	 * If the device supports only one port type, this setting is ignored.
 	 **/
+	/* plugins docs
+	 * ---ifcfg-rh---
+	 * property: port
+	 * variable: (none)
+	 * description: The property is not saved by the plugin.
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_PORT,
 		 g_param_spec_string (NM_SETTING_WIRED_PORT, "", "",
@@ -885,6 +892,13 @@ nm_setting_wired_class_init (NMSettingWiredClass *setting_class)
 	 * If non-zero, request that the device use only the specified speed.  In
 	 * Mbit/s, ie 100 == 100Mbit/s.
 	 **/
+	/* plugins docs
+	 * ---ifcfg-rh---
+	 * property: speed
+	 * variable: (none)
+	 * description: The property is not saved by the plugin.
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_SPEED,
 		 g_param_spec_uint (NM_SETTING_WIRED_SPEED, "", "",
@@ -899,6 +913,13 @@ nm_setting_wired_class_init (NMSettingWiredClass *setting_class)
 	 * If specified, request that the device only use the specified duplex mode.
 	 * Either "half" or "full".
 	 **/
+	/* plugins docs
+	 * ---ifcfg-rh---
+	 * property: duplex
+	 * variable: (none)
+	 * description: The property is not saved by the plugin.
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_DUPLEX,
 		 g_param_spec_string (NM_SETTING_WIRED_DUPLEX, "", "",
@@ -913,6 +934,13 @@ nm_setting_wired_class_init (NMSettingWiredClass *setting_class)
 	 * %FALSE, do not allow auto-negotiation, in which case the "speed" and
 	 * "duplex" properties should be set.
 	 **/
+	/* plugins docs
+	 * ---ifcfg-rh---
+	 * property: auto-negotiate
+	 * variable: (none)
+	 * description: The property is not saved by the plugin.
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_AUTO_NEGOTIATE,
 		 g_param_spec_boolean (NM_SETTING_WIRED_AUTO_NEGOTIATE, "", "",
@@ -936,6 +964,12 @@ nm_setting_wired_class_init (NMSettingWiredClass *setting_class)
 	 *   (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---
+	 * property: mac-address
+	 * variable: HWADDR
+	 * description: Hardware address of the device in traditional hex-digits-and-colons
+	 *    notation (e.g. 00:22:68:14:5A:05).
+	 * ---end---
 	 */
 	g_object_class_install_property
 		(object_class, PROP_MAC_ADDRESS,
@@ -959,6 +993,12 @@ nm_setting_wired_class_init (NMSettingWiredClass *setting_class)
 	 *   (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---
+	 * 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---
 	 */
 	g_object_class_install_property
 		(object_class, PROP_CLONED_MAC_ADDRESS,
@@ -983,6 +1023,13 @@ nm_setting_wired_class_init (NMSettingWiredClass *setting_class)
 	 * description: MAC address blacklist.
 	 * example: mac-address-blacklist= 00:22:68:12:79:A6;00:22:68:12:79:78
 	 * ---end---
+	 * ---ifcfg-rh---
+	 * property: mac-address-blacklist
+	 * variable: HWADDR_BLACKLIST(+)
+	 * description: It denies usage of the connection for any device whose address
+	 *   is listed.
+	 * example: HWADDR_BLACKLIST="00:22:68:11:69:08 00:11:22:11:44:55"
+	 * ---end---
 	 */
 	g_object_class_install_property
 		(object_class, PROP_MAC_ADDRESS_BLACKLIST,
@@ -998,6 +1045,13 @@ nm_setting_wired_class_init (NMSettingWiredClass *setting_class)
 	 * If non-zero, only transmit packets of the specified size or smaller,
 	 * breaking larger packets up into multiple Ethernet frames.
 	 **/
+	/* plugins docs
+	 * ---ifcfg-rh---
+	 * property: mtu
+	 * variable: MTU
+	 * description: MTU of the interface.
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_MTU,
 		 g_param_spec_uint (NM_SETTING_WIRED_MTU, "", "",
@@ -1018,6 +1072,14 @@ nm_setting_wired_class_init (NMSettingWiredClass *setting_class)
 	 * and each string may only be composed of hexadecimal characters and the
 	 * period (.) character.
 	 **/
+	/* plugins docs
+	 * ---ifcfg-rh---
+	 * property: s390-subchannels
+	 * variable: SUBCHANNELS
+	 * description: Subchannels for IBM S390 hosts.
+	 * example: SUBCHANNELS=0.0.b00a,0.0.b00b,0.0.b00c
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_S390_SUBCHANNELS,
 		 _nm_param_spec_specialized (NM_SETTING_WIRED_S390_SUBCHANNELS, "", "",
@@ -1032,6 +1094,15 @@ nm_setting_wired_class_init (NMSettingWiredClass *setting_class)
 	 * s390 network device type; one of "qeth", "lcs", or "ctc", representing
 	 * the different types of virtual network devices available on s390 systems.
 	 **/
+	/* plugins docs
+	 * ---ifcfg-rh---
+	 * property: s390-nettype
+	 * variable: NETTYPE
+	 * values: "qeth", "lcs" or "ctc"
+	 * description: Network type of the S390 host.
+	 * example: NETTYPE=qeth
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_S390_NETTYPE,
 		 g_param_spec_string (NM_SETTING_WIRED_S390_NETTYPE, "", "",
@@ -1048,6 +1119,14 @@ nm_setting_wired_class_init (NMSettingWiredClass *setting_class)
 	 * "portname", "protocol", among others.  Key names must contain only
 	 * alphanumeric characters (ie, [a-zA-Z0-9]).
 	 **/
+	/* plugins docs
+	 * ---ifcfg-rh---
+	 * property: s390-options
+	 * variable: OPTIONS and PORTNAME, CTCPROTO,
+	 * description: S390 device options. All options go to OPTIONS, except for
+	 *   "portname" and "ctcprot" that have their own variables.
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_S390_OPTIONS,
 		 _nm_param_spec_specialized (NM_SETTING_WIRED_S390_OPTIONS, "", "",