summaryrefslogtreecommitdiff
path: root/libnm-util/nm-setting-connection.c
diff options
context:
space:
mode:
authorDan Winship <danw@gnome.org>2014-10-28 09:58:25 -0400
committerDan Winship <danw@redhat.com>2014-11-19 09:24:09 -0500
commitc14486984ec087cabda61bb6ef2a5c587bbaf760 (patch)
treeed71cede12adc3b0b2244264f2d2547b259eae2b /libnm-util/nm-setting-connection.c
parent3889ff864c5fab3b6d86f0fe19acc206cc5fb37c (diff)
downloadNetworkManager-c14486984ec087cabda61bb6ef2a5c587bbaf760.tar.gz
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.)
Diffstat (limited to 'libnm-util/nm-setting-connection.c')
-rw-r--r--libnm-util/nm-setting-connection.c95
1 files changed, 0 insertions, 95 deletions
diff --git a/libnm-util/nm-setting-connection.c b/libnm-util/nm-setting-connection.c
index 80e225b91b..162ae7cb02 100644
--- a/libnm-util/nm-setting-connection.c
+++ b/libnm-util/nm-setting-connection.c
@@ -1104,13 +1104,6 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class)
* A human readable unique identifier for the connection, like "Work Wi-Fi"
* or "T-Mobile 3G".
**/
- /* plugins docs
- * ---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, "", "",
@@ -1135,14 +1128,6 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class)
* be generated by nm_utils_uuid_generate() or
* nm_utils_uuid_generate_from_string().
**/
- /* plugins docs
- * ---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, "", "",
@@ -1168,15 +1153,6 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class)
*
* Since: 0.9.10
**/
- /* plugins docs
- * ---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, "", "",
@@ -1194,16 +1170,6 @@ 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).
**/
- /* plugins docs
- * ---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, "", "",
@@ -1227,15 +1193,6 @@ 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.
*/
- /* plugins docs
- * ---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,
_nm_param_spec_specialized (NM_SETTING_CONNECTION_PERMISSIONS, "", "",
@@ -1251,14 +1208,6 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class)
* %TRUE to automatically activate the connection, %FALSE to require manual
* intervention to activate the connection.
**/
- /* plugins docs
- * ---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, "", "",
@@ -1312,15 +1261,6 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class)
* the connection will be placed in the default zone as defined by the
* firewall.
**/
- /* plugins docs
- * ---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, "", "",
@@ -1335,14 +1275,6 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class)
*
* Interface name of the master device or UUID of the master connection.
**/
- /* plugins docs
- * ---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, "", "",
@@ -1359,15 +1291,6 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class)
* %NM_SETTING_BOND_SETTING_NAME), or %NULL if this connection is not a
* slave.
**/
- /* plugins docs
- * ---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, "", "",
@@ -1386,14 +1309,6 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class)
*
* Since: 0.9.8
**/
- /* plugins docs
- * ---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,
_nm_param_spec_specialized (NM_SETTING_CONNECTION_SECONDARIES, "", "",
@@ -1410,16 +1325,6 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class)
*
* Since: 0.9.10
**/
- /* plugins docs
- * ---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, "", "",