libnm, libnm-util: move settings doc generation to libnm-core

Move the settings/plugins doc generation from libnm-util to
libnm-core, since libnm-util isn't being updated for all new
properties.

With this commit, the keyfile and ifcfg-rh documentation is basically
unchanged, except that deprecated properties are now gone, and new
properties have been added, and the sections are in a different order.
(generate-plugin-docs.pl just outputs the settings in Makefile order,
and they were unsorted in libnm-util, but are sorted in libnm-core).

The settings documentation used for nm-settings.5, the D-Bus API docs,
and the nmcli help is changed a bit more at this point, and mostly for
the worse, since the libnm-core setting properties don't match up with
the D-Bus API as well as the libnm-util ones do. To be fixed...

(I also removed the "plugins docs" line in each plugin docs comment
block while moving them, since those blocks will be used for more than
just plugins soon, and it's sort of obvious anyway.)

1 files changed, 0 insertions, 105 deletions

diff --git a/libnm-util/nm-setting-wired.c b/libnm-util/nm-setting-wired.c
index 5a90d7ddec..8d927921db 100644
--- a/libnm-util/nm-setting-wired.c
+++ b/libnm-util/nm-setting-wired.c
@@ -874,13 +874,6 @@ 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, "", "",
@@ -894,13 +887,6 @@ 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, "", "",
@@ -915,13 +901,6 @@ 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, "", "",
@@ -936,13 +915,6 @@ 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, "", "",
@@ -958,21 +930,6 @@ 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---
-	 * ---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,
 		 _nm_param_spec_specialized (NM_SETTING_WIRED_MAC_ADDRESS, "", "",
@@ -987,21 +944,6 @@ 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---
-	 * ---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,
 		 _nm_param_spec_specialized (NM_SETTING_WIRED_CLONED_MAC_ADDRESS, "", "",
@@ -1018,21 +960,6 @@ 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---
-	 * ---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,
 		 _nm_param_spec_specialized (NM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST, "", "",
@@ -1047,13 +974,6 @@ 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, "", "",
@@ -1074,14 +994,6 @@ 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, "", "",
@@ -1096,15 +1008,6 @@ 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, "", "",
@@ -1121,14 +1024,6 @@ 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, "", "",