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

diff --git a/libnm-core/nm-setting-dcb.c b/libnm-core/nm-setting-dcb.c
index 6b213db7b6..a4fa00c840 100644
--- a/libnm-core/nm-setting-dcb.c
+++ b/libnm-core/nm-setting-dcb.c
@@ -917,6 +917,14 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class)
 	 * be any combination of %NM_SETTING_DCB_FLAG_ENABLE,
 	 * %NM_SETTING_DCB_FLAG_ADVERTISE, and %NM_SETTING_DCB_FLAG_WILLING.
 	 **/
+	/* ---ifcfg-rh---
+	 * property: app-fcoe-flags
+	 * variable: DCB_APP_FCOE_ENABLE, DCB_APP_FCOE_ADVERTISE, DCB_APP_FCOE_WILLING
+	 * description: FCOE flags.
+	 * default: no
+	 * example: DCB_APP_FCOE_ENABLE=yes DCB_APP_FCOE_ADVERTISE=yes
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_APP_FCOE_FLAGS,
 		 g_param_spec_flags (NM_SETTING_DCB_APP_FCOE_FLAGS, "", "",
@@ -932,6 +940,13 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class)
 	 * default priority.  Only used when the #NMSettingDcb:app-fcoe-flags
 	 * property includes the %NM_SETTING_DCB_FLAG_ENABLE flag.
 	 **/
+	/* ---ifcfg-rh---
+	 * property: app-fcoe-priority
+	 * variable: DCB_APP_FCOE_PRIORITY
+	 * values: 0 - 7
+	 * description: Priority of FCoE frames.
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_APP_FCOE_PRIORITY,
 		 g_param_spec_int (NM_SETTING_DCB_APP_FCOE_PRIORITY, "", "",
@@ -946,6 +961,14 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class)
 	 * The FCoE controller mode; either %NM_SETTING_DCB_FCOE_MODE_FABRIC
 	 * (default) or %NM_SETTING_DCB_FCOE_MODE_VN2VN.
 	 **/
+	/* ---ifcfg-rh---
+	 * property: app-fcoe-mode
+	 * variable: DCB_APP_FCOE_MODE
+	 * values: fabric, vn2vn
+	 * default: fabric
+	 * description: FCoE controller mode.
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_APP_FCOE_MODE,
 		 g_param_spec_string (NM_SETTING_DCB_APP_FCOE_MODE, "", "",
@@ -961,6 +984,13 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class)
 	 * may be any combination of %NM_SETTING_DCB_FLAG_ENABLE,
 	 * %NM_SETTING_DCB_FLAG_ADVERTISE, and %NM_SETTING_DCB_FLAG_WILLING.
 	 **/
+	/* ---ifcfg-rh---
+	 * property: app-iscsi-flags
+	 * variable: DCB_APP_ISCSI_ENABLE, DCB_APP_ISCSI_ADVERTISE, DCB_APP_ISCSI_WILLING
+	 * default: no
+	 * description: iSCSI flags.
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_APP_ISCSI_FLAGS,
 		 g_param_spec_flags (NM_SETTING_DCB_APP_ISCSI_FLAGS, "", "",
@@ -976,6 +1006,13 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class)
 	 * for default priority. Only used when the #NMSettingDcb:app-iscsi-flags
 	 * property includes the %NM_SETTING_DCB_FLAG_ENABLE flag.
 	 **/
+	/* ---ifcfg-rh---
+	 * property: app-iscsi-priority
+	 * variable: DCB_APP_ISCSI_PRIORITY
+	 * values: 0 - 7
+	 * description: Priority of iSCSI frames.
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_APP_ISCSI_PRIORITY,
 		 g_param_spec_int (NM_SETTING_DCB_APP_ISCSI_PRIORITY, "", "",
@@ -991,6 +1028,13 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class)
 	 * be any combination of %NM_SETTING_DCB_FLAG_ENABLE,
 	 * %NM_SETTING_DCB_FLAG_ADVERTISE, and %NM_SETTING_DCB_FLAG_WILLING.
 	 **/
+	/* ---ifcfg-rh---
+	 * property: app-fip-flags
+	 * variable: DCB_APP_FIP_ENABLE, DCB_APP_FIP_ADVERTISE, DCB_APP_FIP_WILLING
+	 * default: no
+	 * description: FIP flags.
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_APP_FIP_FLAGS,
 		 g_param_spec_flags (NM_SETTING_DCB_APP_FIP_FLAGS, "", "",
@@ -1006,6 +1050,13 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class)
 	 * default priority.  Only used when the #NMSettingDcb:app-fip-flags
 	 * property includes the %NM_SETTING_DCB_FLAG_ENABLE flag.
 	 **/
+	/* ---ifcfg-rh---
+	 * property: app-fip-priority
+	 * variable: DCB_APP_FIP_PRIORITY
+	 * values: 0 - 7
+	 * description: Priority of FIP frames.
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_APP_FIP_PRIORITY,
 		 g_param_spec_int (NM_SETTING_DCB_APP_FIP_PRIORITY, "", "",
@@ -1021,6 +1072,13 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class)
 	 * Flags may be any combination of %NM_SETTING_DCB_FLAG_ENABLE,
 	 * %NM_SETTING_DCB_FLAG_ADVERTISE, and %NM_SETTING_DCB_FLAG_WILLING.
 	 **/
+	/* ---ifcfg-rh---
+	 * property: priority-flow-control-flags
+	 * variable: DCB_PFC_ENABLE, DCB_PFC_ADVERTISE, DCB_PFC_WILLING
+	 * default: no
+	 * description: Priority flow control flags.
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_PFC_FLAGS,
 		 g_param_spec_flags (NM_SETTING_DCB_PRIORITY_FLOW_CONTROL_FLAGS, "", "",
@@ -1038,6 +1096,14 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class)
 	 *
 	 * Element-type: gboolean
 	 **/
+	/* ---ifcfg-rh---
+	 * property: priority-flow-control
+	 * variable: DCB_PFC_UP
+	 * description: Priority flow control values. String of 8 "0" and "1", where "0".
+	 *   means "do not transmit priority pause", "1" means "transmit pause".
+	 * example: DCB_PFC_UP=01101110
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_PFC,
 		 g_param_spec_boxed (NM_SETTING_DCB_PRIORITY_FLOW_CONTROL, "", "",
@@ -1056,6 +1122,13 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class)
 	 * any combination of %NM_SETTING_DCB_FLAG_ENABLE,
 	 * %NM_SETTING_DCB_FLAG_ADVERTISE, and %NM_SETTING_DCB_FLAG_WILLING.
 	 **/
+	/* ---ifcfg-rh---
+	 * property: priority-group-flags
+	 * variable: DCB_PG_ENABLE, DCB_PG_ADVERTISE, DCB_PG_WILLING
+	 * default: no
+	 * description: Priority groups flags.
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_PRIORITY_GROUP_FLAGS,
 		 g_param_spec_flags (NM_SETTING_DCB_PRIORITY_GROUP_FLAGS, "", "",
@@ -1073,6 +1146,14 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class)
 	 *
 	 * Element-type: guint
 	 **/
+	/* ---ifcfg-rh---
+	 * property: priority-group-id
+	 * variable: DCB_PG_ID
+	 * description: Priority groups values. String of eight priorities (0 - 7) or "f"
+	 *   (unrestricted).
+	 * example: DCB_PG_ID=1205f173
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_PRIORITY_GROUP_ID,
 		 g_param_spec_boxed (NM_SETTING_DCB_PRIORITY_GROUP_ID, "", "",
@@ -1094,6 +1175,13 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class)
 	 *
 	 * Element-type: guint
 	 **/
+	/* ---ifcfg-rh---
+	 * property: priority-group-bandwidth
+	 * variable: DCB_PG_PCT
+	 * description: Priority groups values. Eight bandwidths (in percent), separated with commas.
+	 * example: DCB_PG_PCT=10,5,10,15,10,10,10,30
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_PRIORITY_GROUP_BANDWIDTH,
 		 g_param_spec_boxed (NM_SETTING_DCB_PRIORITY_GROUP_BANDWIDTH, "", "",
@@ -1116,6 +1204,14 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class)
 	 *
 	 * Element-type: guint
 	 **/
+	/* ---ifcfg-rh---
+	 * property: priority-bandwidth
+	 * variable: DCB_PG_UPPCT
+	 * description: Priority values. Eight bandwidths (in percent), separated with commas.
+	 *   The sum of the numbers must be 100.
+	 * example: DCB_PG_UPPCT=7,13,10,10,15,15,10,20
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_PRIORITY_BANDWIDTH,
 		 g_param_spec_boxed (NM_SETTING_DCB_PRIORITY_BANDWIDTH, "", "",
@@ -1136,6 +1232,14 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class)
 	 *
 	 * Element-type: gboolean
 	 **/
+	/* ---ifcfg-rh---
+	 * property: priority-strict-bandwidth
+	 * variable: DCB_PG_STRICT
+	 * description: Priority values. String of eight "0" or "1", where "0" means
+	 *   "may not utilize all bandwidth", "1" means "may utilize all bandwidth".
+	 * example: DCB_PG_STRICT=01101110
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_PRIORITY_STRICT,
 		 g_param_spec_boxed (NM_SETTING_DCB_PRIORITY_STRICT_BANDWIDTH, "", "",
@@ -1156,6 +1260,13 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class)
 	 *
 	 * Element-type: guint
 	 **/
+	/* ---ifcfg-rh---
+	 * property: priority-traffic-class
+	 * variable: DCB_PG_UP2TC
+	 * description: Priority values. String of eight trafic class values (0 - 7).
+	 * example: DCB_PG_UP2TC=01623701
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_PRIORITY_TRAFFIC_CLASS,
 		 g_param_spec_boxed (NM_SETTING_DCB_PRIORITY_TRAFFIC_CLASS, "", "",