libnm-util: add keyfile specific description for properties

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

7 files changed, 151 insertions, 0 deletions

diff --git a/libnm-util/nm-setting-bridge.c b/libnm-util/nm-setting-bridge.c
index 789660036f..3f89ca6257 100644
--- a/libnm-util/nm-setting-bridge.c
+++ b/libnm-util/nm-setting-bridge.c
@@ -468,6 +468,16 @@ nm_setting_bridge_class_init (NMSettingBridgeClass *setting_class)
 	 *
 	 * Since: 0.9.10
 	 **/
+	/* plugins docs
+	 * ---keyfile---
+	 * property: mac-address
+	 * format: ususal hex-digits-and-colons notation
+	 * description: MAC address in traditional hex-digits-and-colons notation,
+	 *   or semicolon separated list of 6 decimal bytes (obsolete)
+	 * example: mac-address=00:22:68:12:79:A2
+	 *  mac-address=0;34;104;18;121;162;
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_MAC_ADDRESS,
 		 _nm_param_spec_specialized (NM_SETTING_BRIDGE_MAC_ADDRESS, "", "",
diff --git a/libnm-util/nm-setting-infiniband.c b/libnm-util/nm-setting-infiniband.c
index a9088d20cb..d00858ad29 100644
--- a/libnm-util/nm-setting-infiniband.c
+++ b/libnm-util/nm-setting-infiniband.c
@@ -398,6 +398,15 @@ nm_setting_infiniband_class_init (NMSettingInfinibandClass *setting_class)
 	 * permanent MAC address matches. This property does not change the MAC
 	 * address of the device (i.e. MAC spoofing).
 	 **/
+	/* plugins docs
+	 * ---keyfile---
+	 * property: mac-address
+	 * format: ususal hex-digits-and-colons notation
+	 * description: MAC address in traditional hex-digits-and-colons notation, or
+	 *   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---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_MAC_ADDRESS,
 		 _nm_param_spec_specialized (NM_SETTING_INFINIBAND_MAC_ADDRESS, "", "",
diff --git a/libnm-util/nm-setting-ip4-config.c b/libnm-util/nm-setting-ip4-config.c
index a067627f7a..5434031644 100644
--- a/libnm-util/nm-setting-ip4-config.c
+++ b/libnm-util/nm-setting-ip4-config.c
@@ -1146,6 +1146,14 @@ nm_setting_ip4_config_class_init (NMSettingIP4ConfigClass *setting_class)
 	 * all other methods, these DNS servers are used as the only DNS servers for
 	 * this connection.
 	 **/
+	/* plugins docs
+	 * ---keyfile---
+	 * property: dns
+	 * format: list of DNS IP addresses
+	 * description: List of DNS servers.
+	 * example: dns=1.2.3.4;8.8.8.8;8.8.4.4;
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_DNS,
 		 _nm_param_spec_specialized (NM_SETTING_IP4_CONFIG_DNS, "", "",
@@ -1181,6 +1189,16 @@ nm_setting_ip4_config_class_init (NMSettingIP4ConfigClass *setting_class)
 	 * with the "shared", "link-local", or "disabled" methods as addressing is
 	 * either automatic or disabled with these methods.
 	 **/
+	/* plugins docs
+	 * ---keyfile---
+	 * property: addresses
+	 * variable: address1, address2, ...
+	 * format: address/plen[,gateway]
+	 * description: List of static IP addresses.
+	 * example: address1=192.168.100.100/24,192.168.100.1
+	 *   address2=10.1.1.5/24
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_ADDRESSES,
 		 _nm_param_spec_specialized (NM_SETTING_IP4_CONFIG_ADDRESSES, "", "",
@@ -1201,6 +1219,16 @@ nm_setting_ip4_config_class_init (NMSettingIP4ConfigClass *setting_class)
 	 * Routes cannot be used with the "shared", "link-local", or "disabled"
 	 * methods because there is no upstream network.
 	 **/
+	/* plugins docs
+	 * ---keyfile---
+	 * property: routes
+	 * variable: route1, route2, ...
+	 * format: route/plen[,gateway,metric]
+	 * description: List of IP routes.
+	 * example: route1=8.8.8.0/24,10.1.1.1,77
+	 *   route2=7.7.0.0/16
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_ROUTES,
 		 _nm_param_spec_specialized (NM_SETTING_IP4_CONFIG_ROUTES, "", "",
diff --git a/libnm-util/nm-setting-ip6-config.c b/libnm-util/nm-setting-ip6-config.c
index 49c32dd662..975322ce50 100644
--- a/libnm-util/nm-setting-ip6-config.c
+++ b/libnm-util/nm-setting-ip6-config.c
@@ -1061,6 +1061,14 @@ nm_setting_ip6_config_class_init (NMSettingIP6ConfigClass *setting_class)
 	 * other methods, these DNS servers are used as the only DNS servers for
 	 * this connection.
 	 **/
+	/* plugins docs
+	 * ---keyfile---
+	 * property: dns
+	 * format: list of DNS IP addresses
+	 * description: List of DNS servers.
+	 * example: dns=2001:4860:4860::8888;2001:4860:4860::8844;
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_DNS,
 		 _nm_param_spec_specialized (NM_SETTING_IP6_CONFIG_DNS, "", "",
@@ -1098,6 +1106,15 @@ nm_setting_ip6_config_class_init (NMSettingIP6ConfigClass *setting_class)
 	 * "shared" or "link-local" methods as the interface is automatically
 	 * assigned an address with these methods.
 	 **/
+	/* plugins docs
+	 * ---keyfile---
+	 * property: addresses
+	 * variable: address1, address2, ...
+	 * format: address/plen[,gateway]
+	 * description: List of static IP addresses.
+	 * example: address1=abbe::cafe/96,abbe::1
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_ADDRESSES,
 		 _nm_param_spec_specialized (NM_SETTING_IP6_CONFIG_ADDRESSES, "", "",
@@ -1118,6 +1135,15 @@ nm_setting_ip6_config_class_init (NMSettingIP6ConfigClass *setting_class)
 	 * automatic configuration.  Routes cannot be used with the "shared" or
 	 * "link-local" methods because there is no upstream network.
 	 **/
+	/* plugins docs
+	 * ---keyfile---
+	 * property: routes
+	 * variable: route1, route2, ...
+	 * format: route/plen[,gateway,metric]
+	 * description: List of IP routes.
+	 * example: route1=2001:4860:4860::/64,2620:52:0:2219:222:68ff:fe11:5403
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_ROUTES,
 		 _nm_param_spec_specialized (NM_SETTING_IP6_CONFIG_ROUTES, "", "",
diff --git a/libnm-util/nm-setting-vpn.c b/libnm-util/nm-setting-vpn.c
index 3afc4dd93c..be892da485 100644
--- a/libnm-util/nm-setting-vpn.c
+++ b/libnm-util/nm-setting-vpn.c
@@ -847,6 +847,15 @@ nm_setting_vpn_class_init (NMSettingVPNClass *setting_class)
 	 * Dictionary of key/value pairs of VPN plugin specific data.  Both keys and
 	 * values must be strings.
 	 **/
+	/* plugins docs
+	 * ---keyfile---
+	 * property: data
+	 * variable: separate variables named after keys of the dictionary
+	 * description: The keys of the data dictionary are used as variable names directly
+	 *   under [vpn] section.
+	 * example: remote=ovpn.corp.com cipher=AES-256-CBC username=joe
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_DATA,
 		 _nm_param_spec_specialized (NM_SETTING_VPN_DATA, "", "",
@@ -860,6 +869,15 @@ nm_setting_vpn_class_init (NMSettingVPNClass *setting_class)
 	 * Dictionary of key/value pairs of VPN plugin specific secrets like
 	 * passwords or private keys.  Both keys and values must be strings.
 	 **/
+	/* plugins docs
+	 * ---keyfile---
+	 * property: secrets
+	 * variable: separate variables named after keys of the dictionary
+	 * description: The keys of the secrets dictionary are used as variable names directly
+	 *   under [vpn-secrets] section.
+	 * example: password=Popocatepetl
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_SECRETS,
 		 _nm_param_spec_specialized (NM_SETTING_VPN_SECRETS, "", "",
diff --git a/libnm-util/nm-setting-wired.c b/libnm-util/nm-setting-wired.c
index bc82bf3477..7e0aefe2b4 100644
--- a/libnm-util/nm-setting-wired.c
+++ b/libnm-util/nm-setting-wired.c
@@ -928,6 +928,15 @@ nm_setting_wired_class_init (NMSettingWiredClass *setting_class)
 	 * whose permanent MAC address matches. This property does not change the
 	 * MAC address of the device (i.e. MAC spoofing).
 	 **/
+	/* plugins docs
+	 * ---keyfile---
+	 * property: mac-address
+	 * format: ususal hex-digits-and-colons notation
+	 * description: MAC address in traditional hex-digits-and-colons notation
+	 *   (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---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_MAC_ADDRESS,
 		 _nm_param_spec_specialized (NM_SETTING_WIRED_MAC_ADDRESS, "", "",
@@ -942,6 +951,15 @@ nm_setting_wired_class_init (NMSettingWiredClass *setting_class)
 	 * If specified, request that the device use this MAC address instead of its
 	 * permanent MAC address.  This is known as MAC cloning or spoofing.
 	 **/
+	/* plugins docs
+	 * ---keyfile---
+	 * property: cloned-mac-address
+	 * format: ususal hex-digits-and-colons notation
+	 * description: Cloned MAC address in traditional hex-digits-and-colons notation
+	 *   (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---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_CLONED_MAC_ADDRESS,
 		 _nm_param_spec_specialized (NM_SETTING_WIRED_CLONED_MAC_ADDRESS, "", "",
@@ -958,6 +976,14 @@ nm_setting_wired_class_init (NMSettingWiredClass *setting_class)
 	 * address is in the standard hex-digits-and-colons notation
 	 * (00:11:22:33:44:55).
 	 **/
+	/* plugins docs
+	 * ---keyfile---
+	 * property: mac-address-blacklist
+	 * format: list of MACs (separated with semicolons)
+	 * description: MAC address blacklist.
+	 * example: mac-address-blacklist= 00:22:68:12:79:A6;00:22:68:12:79:78
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_MAC_ADDRESS_BLACKLIST,
 		 _nm_param_spec_specialized (NM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST, "", "",
diff --git a/libnm-util/nm-setting-wireless.c b/libnm-util/nm-setting-wireless.c
index 24fae397b3..bf2f0a1767 100644
--- a/libnm-util/nm-setting-wireless.c
+++ b/libnm-util/nm-setting-wireless.c
@@ -1032,6 +1032,14 @@ nm_setting_wireless_class_init (NMSettingWirelessClass *setting_class)
 	 *
 	 * SSID of the Wi-Fi network. Must be specified.
 	 **/
+	/* plugins docs
+	 * ---keyfile---
+	 * property: ssid
+	 * format: string (or decimal-byte list - obsolete)
+	 * description: SSID of Wi-Fi network.
+	 * example: ssid=Quick Net
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_SSID,
 		 _nm_param_spec_specialized (NM_SETTING_WIRELESS_SSID, "", "",
@@ -1140,6 +1148,15 @@ nm_setting_wireless_class_init (NMSettingWirelessClass *setting_class)
 	 * permanent MAC address matches. This property does not change the MAC
 	 * address of the device (i.e. MAC spoofing).
 	 **/
+	/* plugins docs
+	 * ---keyfile---
+	 * property: mac-address
+	 * format: ususal hex-digits-and-colons notation
+	 * description: MAC address in traditional hex-digits-and-colons notation
+	 *   (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---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_MAC_ADDRESS,
 		 _nm_param_spec_specialized (NM_SETTING_WIRELESS_MAC_ADDRESS, "", "",
@@ -1153,6 +1170,15 @@ nm_setting_wireless_class_init (NMSettingWirelessClass *setting_class)
 	 * If specified, request that the Wi-Fi device use this MAC address instead
 	 * of its permanent MAC address.  This is known as MAC cloning or spoofing.
 	 **/
+	/* plugins docs
+	 * ---keyfile---
+	 * property: cloned-mac-address
+	 * format: ususal hex-digits-and-colons notation
+	 * description: Cloned MAC address in traditional hex-digits-and-colons notation
+	 *   (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---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_CLONED_MAC_ADDRESS,
 		 _nm_param_spec_specialized (NM_SETTING_WIRELESS_CLONED_MAC_ADDRESS, "", "",
@@ -1167,6 +1193,14 @@ nm_setting_wireless_class_init (NMSettingWirelessClass *setting_class)
 	 * connection should never apply.  Each MAC address should be given in the
 	 * standard hex-digits-and-colons notation (eg "00:11:22:33:44:55").
 	 **/
+	/* plugins docs
+	 * ---keyfile---
+	 * property: mac-address-blacklist
+	 * format: list of MACs (separated with semicolons)
+	 * description: MAC address blacklist.
+	 * example: mac-address-blacklist= 00:22:68:12:79:A6;00:22:68:12:79:78
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_MAC_ADDRESS_BLACKLIST,
 		 _nm_param_spec_specialized (NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST, "", "",