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

diff --git a/libnm-util/nm-setting-infiniband.c b/libnm-util/nm-setting-infiniband.c
index d00858ad29..d51973adfa 100644
--- a/libnm-util/nm-setting-infiniband.c
+++ b/libnm-util/nm-setting-infiniband.c
@@ -406,6 +406,13 @@ nm_setting_infiniband_class_init (NMSettingInfinibandClass *setting_class)
 	 *   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---
+	 * ---ifcfg-rh---
+	 * property: mac-address
+	 * variable: HWADDR
+	 * description: IBoIP 20-byte hardware address of the device (in traditional
+	 *   hex-digits-and-colons notation).
+	 * example: HWADDR=01:02:03:04:05:06:07:08:09:0A:01:02:03:04:05:06:07:08:09:11
+	 * ---end---
 	 */
 	g_object_class_install_property
 		(object_class, PROP_MAC_ADDRESS,
@@ -421,6 +428,13 @@ nm_setting_infiniband_class_init (NMSettingInfinibandClass *setting_class)
 	 * If non-zero, only transmit packets of the specified size or smaller,
 	 * breaking larger packets up into multiple 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_INFINIBAND_MTU, "", "",
@@ -436,6 +450,15 @@ nm_setting_infiniband_class_init (NMSettingInfinibandClass *setting_class)
 	 * The IP-over-InfiniBand transport mode. Either "datagram" or
 	 * "connected".
 	 **/
+	/* = plugins docs =
+	 * ---ifcfg-rh---
+	 * property: transport-mode
+	 * variable: CONNECTED_MODE
+	 * default: CONNECTED_MODE=no
+	 * description: CONNECTED_MODE=yes for "connected" mode, CONNECTED_MODE=no for
+	 *   "datagram" mode
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_TRANSPORT_MODE,
 		 g_param_spec_string (NM_SETTING_INFINIBAND_TRANSPORT_MODE, "", "",
@@ -453,6 +476,17 @@ nm_setting_infiniband_class_init (NMSettingInfinibandClass *setting_class)
 	 * unsigned integer, whose high bit is set if it is a "full membership"
 	 * P_Key.
 	 **/
+	/* = plugins docs =
+	 * ---ifcfg-rh---
+	 * property: p-key
+	 * variable: PKEY_ID (and PKEY=yes)
+	 * default: PKEY=no
+	 * description: InfiniBand P_Key. The value can be a hex number prefixed with "0x"
+	 *   or a decimal number.
+	 *   When PKEY_ID is specified, PHYSDEV and DEVICE also must be specified.
+	 * example: PKEY=yes PKEY_ID=2 PHYSDEV=mlx4_ib0 DEVICE=mlx4_ib0.8002
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_P_KEY,
 		 g_param_spec_int (NM_SETTING_INFINIBAND_P_KEY, "", "",
@@ -470,6 +504,15 @@ nm_setting_infiniband_class_init (NMSettingInfinibandClass *setting_class)
 	 * specify the base device by setting either this property or
 	 * #NMSettingInfiniband:mac-address.
 	 **/
+	/* = plugins docs =
+	 * ---ifcfg-rh---
+	 * property: parent
+	 * variable: PHYSDEV (PKEY=yes)
+	 * default: PKEY=no
+	 * description: InfiniBand parent device.
+	 * example: PHYSDEV=ib0
+	 * ---end---
+	 */
 	g_object_class_install_property
 		(object_class, PROP_PARENT,
 		 g_param_spec_string (NM_SETTING_INFINIBAND_PARENT, "", "",