Commit c1448698 authored by Dan Winship's avatar Dan Winship Committed by Dan Winship

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.)
parent 3889ff86
......@@ -152,9 +152,6 @@ valgrind-*.log
/libnm-glib/tests/test-nm-client
/libnm-glib/tests/test-remote-settings-client
/libnm-util/nm-ifcfg-rh-docs.xml
/libnm-util/nm-keyfile-docs.xml
/libnm-util/nm-setting-docs.xml
/libnm-util/nm-version.h
/libnm-util/test-crypto
/libnm-util/tests/test-crypto
......@@ -166,6 +163,9 @@ valgrind-*.log
/libnm-util/tests/test-setting-8021x
/libnm-util/tests/test-setting-dcb
/libnm/nm-ifcfg-rh-docs.xml
/libnm/nm-keyfile-docs.xml
/libnm/nm-setting-docs.xml
/libnm/tests/test-nm-client
/libnm/tests/test-remote-settings-client
/libnm/tests/test-secret-agent
......
......@@ -51,7 +51,7 @@ nmcli_LDADD += $(POLKIT_LIBS)
endif
if BUILD_SETTING_DOCS
settings-docs.c: settings-docs.xsl $(top_builddir)/libnm-util/nm-setting-docs.xml
settings-docs.c: settings-docs.xsl $(top_builddir)/libnm/nm-setting-docs.xml
$(AM_V_GEN) xsltproc --output $@ $^
BUILT_SOURCES = settings-docs.c
......
......@@ -15,7 +15,7 @@ GENERATED_FILES = spec.html
if SETTING_DOCS_AVAILABLE
settings-spec.xml: settings-spec.xsl $(top_builddir)/libnm-util/nm-setting-docs.xml
settings-spec.xml: settings-spec.xsl $(top_builddir)/libnm/nm-setting-docs.xml
$(AM_V_GEN) xsltproc --output $@ $^
# Top-level SGML file includes (depends on) settings-spec.xml
......
This diff is collapsed.
......@@ -726,6 +726,13 @@ nm_setting_bond_class_init (NMSettingBondClass *setting_class)
*
* Type: GHashTable(utf8,utf8)
**/
/* ---ifcfg-rh---
* property: options
* variable: BONDING_OPTS
* description: Bonding options.
* example: BONDING_OPTS="miimon=100 mode=broadcast"
* ---end---
*/
g_object_class_install_property
(object_class, PROP_OPTIONS,
g_param_spec_boxed (NM_SETTING_BOND_OPTIONS, "", "",
......
......@@ -258,6 +258,14 @@ nm_setting_bridge_port_class_init (NMSettingBridgePortClass *setting_class)
*
* The Spanning Tree Protocol (STP) priority of this bridge port.
**/
/* ---ifcfg-rh---
* property: priority
* variable: BRIDGING_OPTS: priority=
* values: 0 - 63
* default: 32
* description: STP priority.
* ---end---
*/
g_object_class_install_property
(object_class, PROP_PRIORITY,
g_param_spec_uint (NM_SETTING_BRIDGE_PORT_PRIORITY, "", "",
......@@ -273,6 +281,14 @@ nm_setting_bridge_port_class_init (NMSettingBridgePortClass *setting_class)
* The Spanning Tree Protocol (STP) port cost for destinations via this
* port.
**/
/* ---ifcfg-rh---
* property: path-cost
* variable: BRIDGING_OPTS: path_cost=
* values: 1 - 65535
* default: 100
* description: STP cost.
* ---end---
*/
g_object_class_install_property
(object_class, PROP_PATH_COST,
g_param_spec_uint (NM_SETTING_BRIDGE_PORT_PATH_COST, "", "",
......@@ -288,6 +304,13 @@ nm_setting_bridge_port_class_init (NMSettingBridgePortClass *setting_class)
* Enables or disabled "hairpin mode" for the port, which allows frames to
* be sent back out through the port the frame was received on.
**/
/* ---ifcfg-rh---
* property: hairpin-mode
* variable: BRIDGING_OPTS: hairpin_mode=
* default: yes
* description: Hairpin mode of the bridge port.
* ---end---
*/
g_object_class_install_property
(object_class, PROP_HAIRPIN_MODE,
g_param_spec_boolean (NM_SETTING_BRIDGE_PORT_HAIRPIN_MODE, "", "",
......
......@@ -364,6 +364,22 @@ nm_setting_bridge_class_init (NMSettingBridgeClass *setting_class)
* MAC address will be set. When matching an existing (outside
* NetworkManager created) bridge, this MAC address must match.
**/
/* ---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---
* ---ifcfg-rh---
* property: mac-address
* variable: MACADDR(+)
* description: MAC address of the bridge. Note that this requires a recent
* kernel support, originally introduced in 3.15 upstream kernel)
* MACADDR for bridges is an NM extension.
* ---end---
*/
g_object_class_install_property
(object_class, PROP_MAC_ADDRESS,
g_param_spec_string (NM_SETTING_BRIDGE_MAC_ADDRESS, "", "",
......@@ -381,6 +397,13 @@ nm_setting_bridge_class_init (NMSettingBridgeClass *setting_class)
*
* Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.
**/
/* ---ifcfg-rh---
* property: stp
* variable: STP
* default: no
* description: Span tree protocol participation.
* ---end---
*/
g_object_class_install_property
(object_class, PROP_STP,
g_param_spec_boolean (NM_SETTING_BRIDGE_STP, "", "",
......@@ -397,6 +420,14 @@ nm_setting_bridge_class_init (NMSettingBridgeClass *setting_class)
* values are "better"; the lowest priority bridge will be elected the root
* bridge.
**/
/* ---ifcfg-rh---
* property: priority
* variable: BRIDGING_OPTS: priority=
* values: 0 - 32768
* default: 32768
* description: STP priority.
* ---end---
*/
g_object_class_install_property
(object_class, PROP_PRIORITY,
g_param_spec_uint (NM_SETTING_BRIDGE_PRIORITY, "", "",
......@@ -411,6 +442,14 @@ nm_setting_bridge_class_init (NMSettingBridgeClass *setting_class)
*
* The Spanning Tree Protocol (STP) forwarding delay, in seconds.
**/
/* ---ifcfg-rh---
* property: forward-delay
* variable: DELAY
* values: 2 - 30
* default: 15
* description: STP forwarding delay.
* ---end---
*/
g_object_class_install_property
(object_class, PROP_FORWARD_DELAY,
g_param_spec_uint (NM_SETTING_BRIDGE_FORWARD_DELAY, "", "",
......@@ -425,6 +464,14 @@ nm_setting_bridge_class_init (NMSettingBridgeClass *setting_class)
*
* The Spanning Tree Protocol (STP) hello time, in seconds.
**/
/* ---ifcfg-rh---
* property: hello-time
* variable: BRIDGING_OPTS: hello_time=
* values: 1 - 10
* default: 2
* description: STP hello time.
* ---end---
*/
g_object_class_install_property
(object_class, PROP_HELLO_TIME,
g_param_spec_uint (NM_SETTING_BRIDGE_HELLO_TIME, "", "",
......@@ -439,6 +486,14 @@ nm_setting_bridge_class_init (NMSettingBridgeClass *setting_class)
*
* The Spanning Tree Protocol (STP) maximum message age, in seconds.
**/
/* ---ifcfg-rh---
* property: max-age
* variable: BRIDGING_OPTS: max_age=
* values: 6 - 40
* default: 20
* description: STP maximum message age.
* ---end---
*/
g_object_class_install_property
(object_class, PROP_MAX_AGE,
g_param_spec_uint (NM_SETTING_BRIDGE_MAX_AGE, "", "",
......@@ -453,6 +508,14 @@ nm_setting_bridge_class_init (NMSettingBridgeClass *setting_class)
*
* The Ethernet MAC address aging time, in seconds.
**/
/* ---ifcfg-rh---
* property: ageing-time
* variable: BRIDGING_OPTS: ageing_time=
* values: 0 - 1000000
* default: 300
* description: Ethernet MAC ageing time.
* ---end---
*/
g_object_class_install_property
(object_class, PROP_AGEING_TIME,
g_param_spec_uint (NM_SETTING_BRIDGE_AGEING_TIME, "", "",
......
......@@ -1223,6 +1223,12 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class)
* A human readable unique identifier for the connection, like "Work Wi-Fi"
* or "T-Mobile 3G".
**/
/* ---ifcfg-rh---
* property: id
* variable: NAME(+)
* description: User friendly name for the connection profile.
* ---end---
*/
g_object_class_install_property
(object_class, PROP_ID,
g_param_spec_string (NM_SETTING_CONNECTION_ID, "", "",
......@@ -1247,6 +1253,13 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class)
* be generated by nm_utils_uuid_generate() or
* nm_utils_uuid_generate_from_string().
**/
/* ---ifcfg-rh---
* property: uuid
* variable: UUID(+)
* description: UUID for the connetcion profile. When missing NetworkManager
* creates the UUID itself (by hashing the file).
* ---end---
*/
g_object_class_install_property
(object_class, PROP_UUID,
g_param_spec_string (NM_SETTING_CONNECTION_UUID, "", "",
......@@ -1270,6 +1283,14 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class)
* can be used with, and if interface names change or are reordered the
* connection may be applied to the wrong interface.
**/
/* ---ifcfg-rh---
* property: interface-name
* variable: DEVICE
* description: Interface name of the device this profile is bound to. The variable
* can be left out when the profile should apply for more devices. Note that DEVICE
* can be required for some connection types.
* ---end---
*/
g_object_class_install_property
(object_class, PROP_INTERFACE_NAME,
g_param_spec_string (NM_SETTING_CONNECTION_INTERFACE_NAME, "", "",
......@@ -1292,6 +1313,15 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class)
* non-hardware dependent connections like VPN or otherwise, should contain
* the setting name of that setting type (ie, "vpn" or "bridge", etc).
**/
/* ---ifcfg-rh---
* property: type
* variable: TYPE (DEVICETYPE, DEVICE)
* values: Ethernet, Wireless, InfiniBand, Bridge, Bond, Vlan, Team, TeamPort
* description: Base type of the connection. DEVICETYPE is used for teaming
* connections.
* example: TYPE=Ethernet; TYPE=Bond; TYPE=Bridge; DEVICETYPE=TeamPort
* ---end---
*/
g_object_class_install_property
(object_class, PROP_TYPE,
g_param_spec_string (NM_SETTING_CONNECTION_TYPE, "", "",
......@@ -1315,6 +1345,14 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class)
* [reserved] information present must be ignored and is reserved for future
* use. All of [type], [id], and [reserved] must be valid UTF-8.
*/
/* ---ifcfg-rh---
* property: permissions
* variable: USERS(+)
* description: USERS restrict the access for this conenction to certain
* users only.
* example: USERS="joe bob"
* ---end---
*/
g_object_class_install_property
(object_class, PROP_PERMISSIONS,
g_param_spec_boxed (NM_SETTING_CONNECTION_PERMISSIONS, "", "",
......@@ -1330,6 +1368,13 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class)
* %TRUE to automatically activate the connection, %FALSE to require manual
* intervention to activate the connection.
**/
/* ---ifcfg-rh---
* property: autoconnect
* variable: ONBOOT
* default: yes
* description: Whether the connection should be autoconnected (not only while booting).
* ---end---
*/
g_object_class_install_property
(object_class, PROP_AUTOCONNECT,
g_param_spec_boolean (NM_SETTING_CONNECTION_AUTOCONNECT, "", "",
......@@ -1401,6 +1446,14 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class)
* the connection will be placed in the default zone as defined by the
* firewall.
**/
/* ---ifcfg-rh---
* property: zone
* variable: ZONE(+)
* description: Trust level of this connection. The string is usually used
* for a firewall.
* example: ZONE=Work
* ---end---
*/
g_object_class_install_property
(object_class, PROP_ZONE,
g_param_spec_string (NM_SETTING_CONNECTION_ZONE, "", "",
......@@ -1415,6 +1468,13 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class)
*
* Interface name of the master device or UUID of the master connection.
**/
/* ---ifcfg-rh---
* property: master
* variable: MASTER, TEAM_MASTER, BRIDGE
* description: Reference to master connection. The variable used depends on
* the connection type.
* ---end---
*/
g_object_class_install_property
(object_class, PROP_MASTER,
g_param_spec_string (NM_SETTING_CONNECTION_MASTER, "", "",
......@@ -1431,6 +1491,14 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class)
* %NM_SETTING_BOND_SETTING_NAME), or %NULL if this connection is not a
* slave.
**/
/* ---ifcfg-rh---
* property: slave-type
* variable: MASTER, TEAM_MASTER, DEVICETYPE, BRIDGE
* description: Slave type doesn't map directly to a variable, but it is
* recognized using different variables. MASTER for bonding,
* TEAM_MASTER and DEVICETYPE for teaming, BRIDGE for bridging.
* ---end---
*/
g_object_class_install_property
(object_class, PROP_SLAVE_TYPE,
g_param_spec_string (NM_SETTING_CONNECTION_SLAVE_TYPE, "", "",
......@@ -1447,6 +1515,13 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class)
* connection itself is activated. Currently only VPN connections are
* supported.
**/
/* ---ifcfg-rh---
* property: secondaries
* variable: SECONDARY_UUIDS(+)
* description: UUID of VPN connections that should be activated
* together with this connection.
* ---end---
*/
g_object_class_install_property
(object_class, PROP_SECONDARIES,
g_param_spec_boxed (NM_SETTING_CONNECTION_SECONDARIES, "", "",
......@@ -1461,6 +1536,15 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class)
* If greater than zero, delay success of IP addressing until either the
* timeout is reached, or an IP gateway replies to a ping.
**/
/* ---ifcfg-rh---
* property: gateway-ping-timeout
* variable: GATEWAY_PING_TIMEOUT(+)
* default: 0
* description: If greater than zero, the IP connectivity will be checked by
* pinging the gateway and waiting for the specified timeout (in seconds).
* example: GATEWAY_PING_TIMEOUT=5
* ---end---
*/
g_object_class_install_property
(object_class, PROP_GATEWAY_PING_TIMEOUT,
g_param_spec_uint (NM_SETTING_CONNECTION_GATEWAY_PING_TIMEOUT, "", "",
......
......@@ -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, "", "",
......
......@@ -396,6 +396,21 @@ 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).
**/
/* ---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---
* ---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,
g_param_spec_string (NM_SETTING_INFINIBAND_MAC_ADDRESS, "", "",
......@@ -414,6 +429,12 @@ 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.
**/
/* ---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, "", "",
......@@ -429,6 +450,14 @@ nm_setting_infiniband_class_init (NMSettingInfinibandClass *setting_class)
* The IP-over-InfiniBand transport mode. Either "datagram" or
* "connected".
**/
/* ---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, "", "",
......@@ -446,6 +475,16 @@ nm_setting_infiniband_class_init (NMSettingInfinibandClass *setting_class)
* unsigned integer, whose high bit is set if it is a "full membership"
* P_Key.
**/
/* ---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, "", "",
......@@ -463,6 +502,14 @@ nm_setting_infiniband_class_init (NMSettingInfinibandClass *setting_class)
* specify the base device by setting either this property or
* #NMSettingInfiniband:mac-address.
**/
/* ---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, "", "",
......
......@@ -442,12 +442,134 @@ nm_setting_ip4_config_class_init (NMSettingIP4ConfigClass *ip4_class)
/* properties */
/* ---ifcfg-rh---
* property: method
* variable: BOOTPROTO
* format: string
* values: none, dhcp (bootp), static, ibft, autoip, shared
* default: none
* description: Method used for IPv4 protocol configuration.
* ---end---
*/
/* ---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---
* ---ifcfg-rh---
* property: dns
* variable: DNS1, DNS2, ...
* format: string
* description: List of DNS servers. Even if NetworkManager supports many DNS
* servers, initscripts and resolver only care about the first three, usually.
* example: DNS1=1.2.3.4 DNS2=10.0.0.254 DNS3=8.8.8.8
* ---end---
*/
/* ---ifcfg-rh---
* property: dns-search
* variable: DOMAIN
* format: string (space-separated domains)
* description: List of DNS search domains.
* ---end---
*/
/* ---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---
* ---ifcfg-rh---
* property: addresses
* variable: IPADDR, PREFIX, GATEWAY, IPADDR1, PREFIX1, GATEWAY1, ...
* description: List of static IP addresses.
* example: IPADDR 10.5.5.23 PREFIX=24 GATEWAY=10.5.5.1
* ---end---
*/
/* ---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---
* ---ifcfg-rh---
* property: routes
* variable: ADDRESS1, NETMASK1, GATEWAY1, METRIC1, ...
* description: List of static routes. They are not stored in ifcfg-* file,
* but in route-* file instead.
* ---end---
*/
/* ---ifcfg-rh---
* property: ignore-auto-routes
* variable: PEERROUTES(+)
* default: yes
* description: PEERROUTES has the opposite meaning as 'ignore-auto-routes' property.
* ---end---
*/
/* ---ifcfg-rh---
* property: ignore-auto-dns
* variable: PEERDNS
* default: yes
* description: PEERDNS has the opposite meaning as 'ignore-auto-dns' property.
* ---end---
*/
/* ---ifcfg-rh---
* property: dhcp-send-hostname
* variable: DHCP_SEND_HOSTNAME(+)
* default: yes
* description: Whether DHCP_HOSTNAME should be sent to the DHCP server.