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, 42 insertions, 0 deletions

diff --git a/libnm-core/nm-setting-vlan.c b/libnm-core/nm-setting-vlan.c
index c1b9940ff1..5a348211e9 100644
--- a/libnm-core/nm-setting-vlan.c
+++ b/libnm-core/nm-setting-vlan.c
@@ -692,6 +692,12 @@ nm_setting_vlan_class_init (NMSettingVlanClass *setting_class)
 	 * not specified, the connection must contain an #NMSettingWired setting
 	 * with a #NMSettingWired:mac-address property.
 	 **/
+	/* ---ifcfg-rh---
+	 * property: parent
+	 * variable: DEVICE or PHYSDEV
+	 * description: Parent interface of the VLAN.
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_PARENT,
 		 g_param_spec_string (NM_SETTING_VLAN_PARENT, "", "",
@@ -707,6 +713,12 @@ nm_setting_vlan_class_init (NMSettingVlanClass *setting_class)
 	 * The VLAN identifier that the interface created by this connection should
 	 * be assigned.
 	 **/
+	/* ---ifcfg-rh---
+	 * property: id
+	 * variable: VLAN_ID or DEVICE
+	 * description: VLAN identifier.
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_ID,
 		 g_param_spec_uint (NM_SETTING_VLAN_ID, "", "",
@@ -725,6 +737,13 @@ nm_setting_vlan_class_init (NMSettingVlanClass *setting_class)
 	 * and %NM_VLAN_FLAG_LOOSE_BINDING (loose binding of the interface to its
 	 * master device's operating state).
 	 **/
+	/* ---ifcfg-rh---
+	 * property: flags
+	 * variable: VLAN_FLAGS, REORDER_HDR
+	 * values: "GVRP", "LOOSE_BINDING" for VLAN_FLAGS; 0 or 1 for REORDER_HDR
+	 * description: Parent interface of the VLAN.
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_FLAGS,
 		 g_param_spec_flags (NM_SETTING_VLAN_FLAGS, "", "",
@@ -742,6 +761,13 @@ nm_setting_vlan_class_init (NMSettingVlanClass *setting_class)
 	 * SKB priorities.  The mapping is given in the format "from:to" where both
 	 * "from" and "to" are unsigned integers, ie "7:3".
 	 **/
+	/* ---ifcfg-rh---
+	 * property: ingress-property-map
+	 * variable: VLAN_INGRESS_PRIORITY_MAP
+	 * description: Ingress priority mapping.
+	 * example: VLAN_INGRESS_PRIORITY_MAP=4:2,3:5
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_INGRESS_PRIORITY_MAP,
 		 g_param_spec_boxed (NM_SETTING_VLAN_INGRESS_PRIORITY_MAP, "", "",
@@ -757,6 +783,13 @@ nm_setting_vlan_class_init (NMSettingVlanClass *setting_class)
 	 * 802.1p priorities.  The mapping is given in the format "from:to" where
 	 * both "from" and "to" are unsigned integers, ie "7:3".
 	 **/
+	/* ---ifcfg-rh---
+	 * property: egress-property-map
+	 * variable: VLAN_EGRESS_PRIORITY_MAP
+	 * description: Egress priority mapping.
+	 * example: VLAN_EGRESS_PRIORITY_MAP=5:4,4:1,3:7
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_EGRESS_PRIORITY_MAP,
 		 g_param_spec_boxed (NM_SETTING_VLAN_EGRESS_PRIORITY_MAP, "", "",
@@ -765,6 +798,15 @@ nm_setting_vlan_class_init (NMSettingVlanClass *setting_class)
 		                     NM_SETTING_PARAM_INFERRABLE |
 		                     G_PARAM_STATIC_STRINGS));
 
+	/* ---ifcfg-rh---
+	 * property: interface-name
+	 * variable: PHYSDEV and VLAN_ID, or DEVICE
+	 * description: VLAN interface name.
+	 *   If all variables are set, parent device from PHYSDEV takes precedence over DEVICE,
+	 *   but VLAN id from DEVICE takes precedence over VLAN_ID.
+	 * example: PHYSDEV=eth0, VLAN_ID=12; or DEVICE=eth0.12
+	 * ---end---
+	 */
 	_nm_setting_class_add_dbus_only_property (parent_class, "interface-name",
 	                                          G_VARIANT_TYPE_STRING,
 	                                          _nm_setting_get_deprecated_virtual_interface_name,