diff options
Diffstat (limited to 'libnm-util')
31 files changed, 1602 insertions, 2240 deletions
diff --git a/libnm-util/Makefile.am b/libnm-util/Makefile.am index 2a3312e180..6874015060 100644 --- a/libnm-util/Makefile.am +++ b/libnm-util/Makefile.am @@ -181,8 +181,20 @@ typelibdir = $(libdir)/girepository-1.0 typelib_DATA = $(INTROSPECTION_GIRS:.gir=.typelib) CLEANFILES += $(gir_DATA) $(typelib_DATA) + +noinst_DATA = nm-setting-docs.xml + +nm-setting-docs.xml: generate-setting-docs.py NetworkManager-1.0.gir libnm-util.la + $(srcdir)/generate-setting-docs.py \ + --gir $(builddir)/NetworkManager-1.0.gir \ + --output $@ + endif +DISTCLEANFILES = nm-setting-docs.xml + +EXTRA_DIST += generate-setting-docs.py + if ENABLE_TESTS check-local: diff --git a/libnm-util/generate-setting-docs.py b/libnm-util/generate-setting-docs.py new file mode 100755 index 0000000000..993b40fd97 --- /dev/null +++ b/libnm-util/generate-setting-docs.py @@ -0,0 +1,192 @@ +#!/usr/bin/env python +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation; either +# version 2 of the License, or (at your option) any later version. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the +# Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, +# Boston, MA 02110-1301 USA. +# +# Copyright 2009 - 2014 Red Hat, Inc. + +from gi.repository import NetworkManager, GObject +import argparse, datetime, re, sys +import xml.etree.ElementTree as ET + +type_name_map = { + 'gchararray': 'string', + 'GSList_gchararray_': 'array of string', + 'GArray_guchar_': 'byte array', + 'gboolean': 'boolean', + 'guint64': 'uint64', + 'gint': 'int32', + 'guint': 'uint32', + 'GArray_guint_': 'array of uint32', + 'GPtrArray_GArray_guint__': 'array of array of uint32', + 'GPtrArray_GArray_guchar__': 'array of byte array', + 'GPtrArray_gchararray_': 'array of string', + 'GHashTable_gchararray+gchararray_': 'dict of (string::string)', + 'GPtrArray_GValueArray_GArray_guchar_+guint+GArray_guchar___': 'array of (byte array, uint32, byte array)', + 'GPtrArray_GValueArray_GArray_guchar_+guint+GArray_guchar_+guint__': 'array of (byte array, uint32, byte array, uint32)' +} + +ns_map = { + 'c': 'http://www.gtk.org/introspection/c/1.0', + 'gi': 'http://www.gtk.org/introspection/core/1.0', + 'glib': 'http://www.gtk.org/introspection/glib/1.0' +} +identifier_key = '{%s}identifier' % ns_map['c'] +nick_key = '{%s}nick' % ns_map['glib'] +symbol_prefix_key = '{%s}symbol-prefix' % ns_map['c'] + +constants = { 'TRUE': 'TRUE', 'FALSE': 'FALSE', 'NULL': 'NULL' } +setting_names = {} + +def init_constants(girxml): + for const in girxml.findall('./gi:namespace/gi:constant', ns_map): + cname = const.attrib['{%s}type' % ns_map['c']] + cvalue = const.attrib['value'] + if const.find('./gi:type[@name="utf8"]', ns_map) is not None: + cvalue = '"%s"' % cvalue + constants[cname] = cvalue + + for enum in girxml.findall('./gi:namespace/gi:enumeration', ns_map): + flag = enum.attrib['name'].endswith('Flags') + for enumval in enum.findall('./gi:member', ns_map): + cname = enumval.attrib[identifier_key] + cvalue = enumval.attrib['value'] + if flag: + cvalue = '%s (0x%x)' % (cname, int(cvalue)) + else: + cvalue = '%s (%s)' % (cname, cvalue) + constants[cname] = cvalue + + for setting in girxml.findall('./gi:namespace/gi:class[@parent="Setting"]', ns_map): + setting_type_name = 'NM' + setting.attrib['name']; + symbol_prefix = setting.attrib[symbol_prefix_key] + setting_name = constants['NM_' + symbol_prefix.upper() + '_SETTING_NAME'] + setting_names[setting_type_name] = setting_name + +def get_prop_type(setting, pspec, propxml): + prop_type = pspec.value_type.name + if type_name_map.has_key(prop_type): + prop_type = type_name_map[prop_type] + if prop_type is None: + prop_type = '' + return prop_type + +def get_docs(setting, pspec, propxml): + doc_xml = propxml.find('gi:doc', ns_map) + if doc_xml is None: + return None + + doc = doc_xml.text + if propxml.attrib.has_key('deprecated'): + doc = doc + ' Deprecated: ' + propxml.attrib['deprecated'] + + doc = re.sub(r'\n\s*', r' ', doc) + + # Expand constants + doc = re.sub(r'%([^%]\w*)', lambda match: constants[match.group(1)], doc) + + # #NMSettingWired:mac-address -> "mac-address" + doc = re.sub(r'#[A-Za-z0-9_]*:([A-Za-z0-9_-]*)', r'"\1"', doc) + + # #NMSettingWired setting -> "802-3-ethernet" setting + doc = re.sub(r'#([A-Z]\w*) setting', lambda match: setting_names[match.group(1)] + ' setting', doc) + + # remaining gtk-doc cleanup + doc = doc.replace('%%', '%') + doc = re.sub(r'#([A-Z]\w*)', r'\1', doc) + + # Remove sentences that refer to functions + doc = re.sub(r'\.\s+[^.]*\w\(\)[^.]*\.', r'.', doc) + + return doc + +def get_default_value(setting, pspec, propxml): + default_value = setting.get_property(pspec.name.replace('-', '_')) + if default_value is None: + return default_value + + value_type = get_prop_type(setting, pspec, propxml) + if value_type == 'string' and default_value != '' and pspec.name != 'name': + default_value = '"%s"' % default_value + elif value_type == 'gchar' and default_value != '': + default_value = "'%s'" % default_value + elif value_type == 'boolean': + default_value = str(default_value).upper() + elif value_type == 'byte array': + default_value = '[]' + elif str(default_value).startswith('<'): + default_value = None + + return default_value + +def escape(val): + return str(val).replace('"', '"') + +def usage(): + print "Usage: %s --gir FILE --output FILE" % sys.argv[0] + exit() + +parser = argparse.ArgumentParser() +parser.add_argument('-g', '--gir', metavar='FILE', help='NetworkManager-1.0.gir file') +parser.add_argument('-o', '--output', metavar='FILE', help='output file') + +args = parser.parse_args() +if args.gir is None or args.output is None: + usage() + +NetworkManager.utils_init() + +girxml = ET.parse(args.gir).getroot() +outfile = open(args.output, mode='w') + +init_constants(girxml) + +basexml = girxml.find('./gi:namespace/gi:class[@name="Setting"]', ns_map) +settings = girxml.findall('./gi:namespace/gi:class[@parent="Setting"]', ns_map) +settings = sorted(settings, key=lambda setting: setting.attrib['{%s}symbol-prefix' % ns_map['c']]) + +outfile.write("""<?xml version=\"1.0\"?> +<!DOCTYPE nm-setting-docs [ +<!ENTITY quot """> +]> +<nm-setting-docs> +""") + +for settingxml in settings: + new_func = NetworkManager.__getattr__(settingxml.attrib['name']) + setting = new_func() + + outfile.write(" <setting name=\"%s\">\n" % setting.props.name) + + properties = sorted(GObject.list_properties(setting), key=lambda prop: prop.name) + for pspec in properties: + propxml = settingxml.find('./gi:property[@name="%s"]' % pspec.name, ns_map) + if propxml is None: + propxml = basexml.find('./gi:property[@name="%s"]' % pspec.name, ns_map) + + value_type = get_prop_type(setting, pspec, propxml) + value_desc = get_docs(setting, pspec, propxml) + default_value = get_default_value(setting, pspec, propxml) + + if default_value is not None: + outfile.write(" <property name=\"%s\" type=\"%s\" default=\"%s\" description=\"%s\" />\n" % + (pspec.name, value_type, escape(default_value), escape(value_desc))) + else: + outfile.write(" <property name=\"%s\" type=\"%s\" description=\"%s\" />\n" % + (pspec.name, value_type, escape(value_desc))) + + outfile.write(" </setting>\n") + +outfile.write("</nm-setting-docs>\n") +outfile.close() diff --git a/libnm-util/nm-connection.c b/libnm-util/nm-connection.c index 8546d9bcb9..934c8610c0 100644 --- a/libnm-util/nm-connection.c +++ b/libnm-util/nm-connection.c @@ -582,7 +582,7 @@ nm_connection_diff (NMConnection *a, * * Validates the connection and all its settings. Each setting's properties * have allowed values, and some values are dependent on other values. For - * example, if a WiFi connection is security enabled, the #NMSettingWireless + * example, if a Wi-Fi connection is security enabled, the #NMSettingWireless * setting object's 'security' property must contain the setting name of the * #NMSettingWirelessSecurity object, which must also be present in the * connection for the connection to be valid. As another example, the @@ -987,7 +987,7 @@ nm_connection_to_hash (NMConnection *connection, NMSettingHashFlags flags) * %NM_SETTING_WIRELESS_SETTING_NAME or %NM_SETTING_WIRED_SETTING_NAME) * * A convenience function to check if the given @connection is a particular - * type (ie wired, wifi, ppp, etc). Checks the #NMSettingConnection:type + * type (ie wired, Wi-Fi, ppp, etc). Checks the #NMSettingConnection:type * property of the connection and matches that against @type. * * Returns: %TRUE if the connection is of the given @type, %FALSE if not @@ -1829,11 +1829,10 @@ nm_connection_class_init (NMConnectionClass *klass) **/ g_object_class_install_property (object_class, PROP_PATH, - g_param_spec_string (NM_CONNECTION_PATH, - "Path", - "Path", - NULL, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + g_param_spec_string (NM_CONNECTION_PATH, "", "", + NULL, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); /* Signals */ diff --git a/libnm-util/nm-setting-8021x.c b/libnm-util/nm-setting-8021x.c index 1ce0caeaad..27a05a61d6 100644 --- a/libnm-util/nm-setting-8021x.c +++ b/libnm-util/nm-setting-8021x.c @@ -42,7 +42,7 @@ * * The #NMSetting8021x object is a #NMSetting subclass that describes * properties necessary for connection to 802.1x-authenticated networks, such as - * WPA and WPA2 Enterprise WiFi networks and wired 802.1x networks. 802.1x + * WPA and WPA2 Enterprise Wi-Fi networks and wired 802.1x networks. 802.1x * connections typically use certificates and/or EAP authentication methods to * securely verify, identify, and authenticate the client to the network itself, * instead of simply relying on a widely shared static key. @@ -52,7 +52,7 @@ * the relevant wpa_supplicant configuration options. * * Furthermore, to get a good idea of 802.1x, EAP, TLS, TTLS, etc and their - * applications to WiFi and wired networks, you'll want to get copies of the + * applications to Wi-Fi and wired networks, you'll want to get copies of the * following books. * * 802.11 Wireless Networks: The Definitive Guide, Second Edition @@ -3136,39 +3136,30 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class) * NMSetting8021x:eap: * * The allowed EAP method to be used when authenticating to the network with - * 802.1x. Valid methods are: "leap", "md5", "tls", "peap", "ttls", "pwd" and - * "fast". Each method requires different configuration using the - * properties of this object; refer to wpa_supplicant documentation for the + * 802.1x. Valid methods are: "leap", "md5", "tls", "peap", "ttls", "pwd", + * and "fast". Each method requires different configuration using the + * properties of this setting; refer to wpa_supplicant documentation for the * allowed combinations. **/ g_object_class_install_property (object_class, PROP_EAP, - _nm_param_spec_specialized (NM_SETTING_802_1X_EAP, - "EAP", - "The allowed EAP method to be used when " - "authenticating to the network with 802.1x. " - "Valid methods are: 'leap', 'md5', 'tls', 'peap', " - "'ttls', 'pwd', and 'fast'. Each method requires " - "different configuration using the properties of " - "this setting; refer to wpa_supplicant " - "documentation for the allowed combinations.", - DBUS_TYPE_G_LIST_OF_STRING, - G_PARAM_READWRITE)); + _nm_param_spec_specialized (NM_SETTING_802_1X_EAP, "", "", + DBUS_TYPE_G_LIST_OF_STRING, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSetting8021x:identity: * - * Identity string for EAP authentication methods. Often the user's - * user or login name. + * Identity string for EAP authentication methods. Often the user's user or + * login name. **/ g_object_class_install_property (object_class, PROP_IDENTITY, - g_param_spec_string (NM_SETTING_802_1X_IDENTITY, - "Identity", - "Identity string for EAP authentication methods. " - "Often the user's user or login name.", - NULL, - G_PARAM_READWRITE)); + g_param_spec_string (NM_SETTING_802_1X_IDENTITY, "", "", + NULL, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSetting8021x:anonymous-identity: @@ -3179,14 +3170,10 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class) **/ g_object_class_install_property (object_class, PROP_ANONYMOUS_IDENTITY, - g_param_spec_string (NM_SETTING_802_1X_ANONYMOUS_IDENTITY, - "Anonymous identity", - "Anonymous identity string for EAP authentication " - "methods. Used as the unencrypted identity with EAP " - "types that support different tunneled identity like " - "EAP-TTLS.", - NULL, - G_PARAM_READWRITE)); + g_param_spec_string (NM_SETTING_802_1X_ANONYMOUS_IDENTITY, "", "", + NULL, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSetting8021x:pac-file: @@ -3195,39 +3182,35 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class) **/ g_object_class_install_property (object_class, PROP_PAC_FILE, - g_param_spec_string (NM_SETTING_802_1X_PAC_FILE, - "PAC file", - "UTF-8 encoded file path containing PAC for EAP-FAST.", - NULL, - G_PARAM_READWRITE)); + g_param_spec_string (NM_SETTING_802_1X_PAC_FILE, "", "", + NULL, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSetting8021x:ca-cert: * * Contains the CA certificate if used by the EAP method specified in the - * #NMSetting8021x:eap property. Setting this property directly is - * discouraged; use the nm_setting_802_1x_set_ca_cert() function instead. + * #NMSetting8021x:eap property. + * + * Certificate data is specified using a "scheme"; two are currently + * supported: blob and path. When using the blob scheme (which is backwards + * compatible with NM 0.7.x) this property should be set to the + * certificate's DER encoded data. When using the path scheme, this property + * should be set to the full UTF-8 encoded path of the certificate, prefixed + * with the string "file://" and ending with a terminating NUL byte. This + * property can be unset even if the EAP method supports CA certificates, + * but this allows man-in-the-middle attacks and is NOT recommended. + * + * Setting this property directly is discouraged; use the + * nm_setting_802_1x_set_ca_cert() function instead. **/ g_object_class_install_property (object_class, PROP_CA_CERT, - _nm_param_spec_specialized (NM_SETTING_802_1X_CA_CERT, - "CA certificate", - "Contains the CA certificate if used by the EAP " - "method specified in the 'eap' property. " - "Certificate data is specified using a 'scheme'; " - "two are currently supported: blob and path. " - "When using the blob scheme (which is backwards " - "compatible with NM 0.7.x) this property should " - "be set to the certificate's DER encoded data. " - "When using the path scheme, this property should " - "be set to the full UTF-8 encoded path of the " - "certificate, prefixed with the string 'file://' " - "and ending with a terminating NULL byte. This " - "property can be unset even if the EAP method " - "supports CA certificates, but this allows " - "man-in-the-middle attacks and is NOT recommended.", - DBUS_TYPE_G_UCHAR_ARRAY, - G_PARAM_READWRITE)); + _nm_param_spec_specialized (NM_SETTING_802_1X_CA_CERT, "", "", + DBUS_TYPE_G_UCHAR_ARRAY, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSetting8021x:ca-path: @@ -3238,80 +3221,61 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class) **/ g_object_class_install_property (object_class, PROP_CA_PATH, - g_param_spec_string (NM_SETTING_802_1X_CA_PATH, - "CA path", - "UTF-8 encoded path to a directory containing PEM or " - "DER formatted certificates to be added to the " - "verification chain in addition to the certificate " - "specified in the 'ca-cert' property.", - NULL, - G_PARAM_READWRITE)); + g_param_spec_string (NM_SETTING_802_1X_CA_PATH, "", "", + NULL, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSetting8021x:subject-match: * - * Substring to be matched against the subject of the certificate - * presented by the authentication server. When unset, no - * verification of the authentication server certificate's subject - * is performed. + * Substring to be matched against the subject of the certificate presented + * by the authentication server. When unset, no verification of the + * authentication server certificate's subject is performed. **/ g_object_class_install_property (object_class, PROP_SUBJECT_MATCH, - g_param_spec_string (NM_SETTING_802_1X_SUBJECT_MATCH, - "Subject match", - "Substring to be matched against the subject of " - "the certificate presented by the authentication " - "server. When unset, no verification of the " - "authentication server certificate's subject is " - "performed.", - NULL, - G_PARAM_READWRITE)); + g_param_spec_string (NM_SETTING_802_1X_SUBJECT_MATCH, "", "", + NULL, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSetting8021x:altsubject-matches: * * List of strings to be matched against the altSubjectName of the - * certificate presented by the authentication server. If the list - * is empty, no verification of the server certificate's - * altSubjectName is performed. + * certificate presented by the authentication server. If the list is empty, + * no verification of the server certificate's altSubjectName is performed. **/ - g_object_class_install_property - (object_class, PROP_ALTSUBJECT_MATCHES, - _nm_param_spec_specialized (NM_SETTING_802_1X_ALTSUBJECT_MATCHES, - "altSubjectName matches", - "List of strings to be matched against " - "the altSubjectName of the certificate " - "presented by the authentication server. " - "If the list is empty, no verification " - "of the server certificate's " - "altSubjectName is performed.", - DBUS_TYPE_G_LIST_OF_STRING, - G_PARAM_READWRITE)); + g_object_class_install_property + (object_class, PROP_ALTSUBJECT_MATCHES, + _nm_param_spec_specialized (NM_SETTING_802_1X_ALTSUBJECT_MATCHES, "", "", + DBUS_TYPE_G_LIST_OF_STRING, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSetting8021x:client-cert: * * Contains the client certificate if used by the EAP method specified in - * the #NMSetting8021x:eap property. Setting this property directly is - * discouraged; use the nm_setting_802_1x_set_client_cert() function instead. + * the #NMSetting8021x:eap property. + * + * Certificate data is specified using a "scheme"; two are currently + * supported: blob and path. When using the blob scheme (which is backwards + * compatible with NM 0.7.x) this property should be set to the + * certificate's DER encoded data. When using the path scheme, this property + * should be set to the full UTF-8 encoded path of the certificate, prefixed + * with the string "file://" and ending with a terminating NUL byte. + * + * Setting this property directly is discouraged; use the + * nm_setting_802_1x_set_client_cert() function instead. **/ g_object_class_install_property (object_class, PROP_CLIENT_CERT, - _nm_param_spec_specialized (NM_SETTING_802_1X_CLIENT_CERT, - "Client certificate", - "Contains the client certificate if used by the " - "EAP method specified in the 'eap' property. " - "Certificate data is specified using a 'scheme'; " - "two are currently supported: blob and path. " - "When using the blob scheme (which is backwards " - "compatible with NM 0.7.x) this property should " - "be set to the certificate's DER encoded data. " - "When using the path scheme, this property should " - "be set to the full UTF-8 encoded path of the " - "certificate, prefixed with the string 'file://' " - "and ending with a terminating NULL byte.", - DBUS_TYPE_G_UCHAR_ARRAY, - G_PARAM_READWRITE)); + _nm_param_spec_specialized (NM_SETTING_802_1X_CLIENT_CERT, "", "", + DBUS_TYPE_G_UCHAR_ARRAY, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSetting8021x:phase1-peapver: @@ -3325,17 +3289,10 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class) **/ g_object_class_install_property (object_class, PROP_PHASE1_PEAPVER, - g_param_spec_string (NM_SETTING_802_1X_PHASE1_PEAPVER, - "Phase1 PEAPVER", - "Forces which PEAP version is used when PEAP is set " - "as the EAP method in 'eap' property. When unset, " - "the version reported by the server will be used. " - "Sometimes when using older RADIUS servers, it is " - "necessary to force the client to use a particular " - "PEAP version. To do so, this property may be set to " - "'0' or '1' to force that specific PEAP version.", - NULL, - G_PARAM_READWRITE)); + g_param_spec_string (NM_SETTING_802_1X_PHASE1_PEAPVER, "", "", + NULL, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSetting8021x:phase1-peaplabel: @@ -3347,15 +3304,10 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class) **/ g_object_class_install_property (object_class, PROP_PHASE1_PEAPLABEL, - g_param_spec_string (NM_SETTING_802_1X_PHASE1_PEAPLABEL, - "Phase1 PEAP label", - "Forces use of the new PEAP label during key " - "derivation. Some RADIUS servers may require forcing " - "the new PEAP label to interoperate with PEAPv1. " - "Set to '1' to force use of the new PEAP label. See " - "the wpa_supplicant documentation for more details.", - NULL, - G_PARAM_READWRITE)); + g_param_spec_string (NM_SETTING_802_1X_PHASE1_PEAPLABEL, "", "", + NULL, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSetting8021x:phase1-fast-provisioning: @@ -3369,98 +3321,70 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class) **/ g_object_class_install_property (object_class, PROP_PHASE1_FAST_PROVISIONING, - g_param_spec_string (NM_SETTING_802_1X_PHASE1_FAST_PROVISIONING, - "Phase1 fast provisioning", - "Enables or disables in-line provisioning of EAP-FAST " - "credentials when FAST is specified as the EAP method " - "in the #NMSetting8021x:eap property. Allowed values " - "are '0' (disabled), '1' (allow unauthenticated " - "provisioning), '2' (allow authenticated provisioning), " - "and '3' (allow both authenticated and unauthenticated " - "provisioning). See the wpa_supplicant documentation " - "for more details.", - NULL, - G_PARAM_READWRITE)); + g_param_spec_string (NM_SETTING_802_1X_PHASE1_FAST_PROVISIONING, "", "", + NULL, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSetting8021x:phase2-auth: * * Specifies the allowed "phase 2" inner non-EAP authentication methods when * an EAP method that uses an inner TLS tunnel is specified in the - * #NMSetting8021x:eap property. Recognized non-EAP phase2 methods are + * #NMSetting8021x:eap property. Recognized non-EAP "phase 2" methods are * "pap", "chap", "mschap", "mschapv2", "gtc", "otp", "md5", and "tls". - * Each 'phase 2' inner method requires specific parameters for successful + * Each "phase 2" inner method requires specific parameters for successful * authentication; see the wpa_supplicant documentation for more details. **/ g_object_class_install_property (object_class, PROP_PHASE2_AUTH, - g_param_spec_string (NM_SETTING_802_1X_PHASE2_AUTH, - "Phase2 auth", - "Specifies the allowed 'phase 2' inner non-EAP " - "authentication methods when an EAP method that uses " - "an inner TLS tunnel is specified in the 'eap' " - "property. Recognized non-EAP phase2 methods are 'pap', " - "'chap', 'mschap', 'mschapv2', 'gtc', 'otp', 'md5', " - "and 'tls'. Each 'phase 2' inner method requires " - "specific parameters for successful authentication; " - "see the wpa_supplicant documentation for more details.", - NULL, - G_PARAM_READWRITE)); + g_param_spec_string (NM_SETTING_802_1X_PHASE2_AUTH, "", "", + NULL, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSetting8021x:phase2-autheap: * * Specifies the allowed "phase 2" inner EAP-based authentication methods * when an EAP method that uses an inner TLS tunnel is specified in the - * #NMSetting8021x:eap property. Recognized EAP-based phase2 methods are - * "md5", "mschapv2", "otp", "gtc", and "tls". Each 'phase 2' inner method + * #NMSetting8021x:eap property. Recognized EAP-based "phase 2" methods are + * "md5", "mschapv2", "otp", "gtc", and "tls". Each "phase 2" inner method * requires specific parameters for successful authentication; see the * wpa_supplicant documentation for more details. **/ g_object_class_install_property (object_class, PROP_PHASE2_AUTHEAP, - g_param_spec_string (NM_SETTING_802_1X_PHASE2_AUTHEAP, - "Phase2 autheap", - "Specifies the allowed 'phase 2' inner EAP-based " - "authentication methods when an EAP method that uses " - "an inner TLS tunnel is specified in the 'eap' " - "property. Recognized EAP-based 'phase 2' methods are " - "'md5', 'mschapv2', 'otp', 'gtc', and 'tls'. Each " - "'phase 2' inner method requires specific parameters " - "for successful authentication; see the wpa_supplicant " - "documentation for more details.", - NULL, - G_PARAM_READWRITE)); + g_param_spec_string (NM_SETTING_802_1X_PHASE2_AUTHEAP, "", "", + NULL, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSetting8021x:phase2-ca-cert: * - * Contains the CA certificate if used by the EAP method specified in the - * #NMSetting8021x:phase2-auth or #NMSetting8021x:phase2-autheap properties. + * Contains the "phase 2" CA certificate if used by the EAP method specified + * in the #NMSetting8021x:phase2-auth or #NMSetting8021x:phase2-autheap + * properties. + * + * Certificate data is specified using a "scheme"; two are currently + * supported: blob and path. When using the blob scheme (which is backwards + * compatible with NM 0.7.x) this property should be set to the + * certificate's DER encoded data. When using the path scheme, this property + * should be set to the full UTF-8 encoded path of the certificate, prefixed + * with the string "file://" and ending with a terminating NUL byte. This + * property can be unset even if the EAP method supports CA certificates, + * but this allows man-in-the-middle attacks and is NOT recommended. + * * Setting this property directly is discouraged; use the * nm_setting_802_1x_set_phase2_ca_cert() function instead. **/ g_object_class_install_property (object_class, PROP_PHASE2_CA_CERT, - _nm_param_spec_specialized (NM_SETTING_802_1X_PHASE2_CA_CERT, - "Phase2 CA certificate", - "Contains the 'phase 2' CA certificate if used by " - "the EAP method specified in the 'phase2-auth' or " - "'phase2-autheap' properties. Certificate data " - "is specified using a 'scheme'; two are currently" - "supported: blob and path. When using the blob " - "scheme (which is backwards compatible with NM " - "0.7.x) this property should be set to the " - "certificate's DER encoded data. When using the " - "path scheme, this property should be set to the " - "full UTF-8 encoded path of the certificate, " - "prefixed with the string 'file://' and ending " - "with a terminating NULL byte. This property can " - "be unset even if the EAP method supports CA " - "certificates, but this allows man-in-the-middle " - "attacks and is NOT recommended.", - DBUS_TYPE_G_UCHAR_ARRAY, - G_PARAM_READWRITE)); + _nm_param_spec_specialized (NM_SETTING_802_1X_PHASE2_CA_CERT, "", "", + DBUS_TYPE_G_UCHAR_ARRAY, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSetting8021x:phase2-ca-path: @@ -3471,156 +3395,146 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class) **/ g_object_class_install_property (object_class, PROP_PHASE2_CA_PATH, - g_param_spec_string (NM_SETTING_802_1X_PHASE2_CA_PATH, - "Phase2 auth CA path", - "UTF-8 encoded path to a directory containing PEM or " - "DER formatted certificates to be added to the " - "verification chain in addition to the certificate " - "specified in the 'phase2-ca-cert' property.", - NULL, - G_PARAM_READWRITE)); + g_param_spec_string (NM_SETTING_802_1X_PHASE2_CA_PATH, "", "", + NULL, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSetting8021x:phase2-subject-match: * - * Substring to be matched against the subject of the certificate - * presented by the authentication server during the inner "phase - * 2" authentication. When unset, no verification of the - * authentication server certificate's subject is performed. + * Substring to be matched against the subject of the certificate presented + * by the authentication server during the inner "phase 2" + * authentication. When unset, no verification of the authentication server + * certificate's subject is performed. **/ g_object_class_install_property (object_class, PROP_PHASE2_SUBJECT_MATCH, - g_param_spec_string (NM_SETTING_802_1X_PHASE2_SUBJECT_MATCH, - "Phase2 subject match", - "Substring to be matched against the subject of " - "the certificate presented by the authentication " - "server during the inner 'phase2' " - "authentication. When unset, no verification of " - "the authentication server certificate's subject " - "is performed.", - NULL, - G_PARAM_READWRITE)); + g_param_spec_string (NM_SETTING_802_1X_PHASE2_SUBJECT_MATCH, "", "", + NULL, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSetting8021x:phase2-altsubject-matches: * * List of strings to be matched against the altSubjectName of the - * certificate presented by the authentication server during the - * inner "phase 2" authentication. If the list is empty, no - * verification of the server certificate's altSubjectName is - * performed. + * certificate presented by the authentication server during the inner + * "phase 2" authentication. If the list is empty, no verification of the + * server certificate's altSubjectName is performed. **/ - g_object_class_install_property - (object_class, PROP_PHASE2_ALTSUBJECT_MATCHES, - _nm_param_spec_specialized (NM_SETTING_802_1X_PHASE2_ALTSUBJECT_MATCHES, - "altSubjectName matches", - "List of strings to be matched against " - "List of strings to be matched against " - "the altSubjectName of the certificate " - "presented by the authentication server " - "during the inner 'phase 2' " - "authentication. If the list is empty, no " - "verification of the server certificate's " - "altSubjectName is performed.", - DBUS_TYPE_G_LIST_OF_STRING, - G_PARAM_READWRITE)); + g_object_class_install_property + (object_class, PROP_PHASE2_ALTSUBJECT_MATCHES, + _nm_param_spec_specialized (NM_SETTING_802_1X_PHASE2_ALTSUBJECT_MATCHES, "", "", + DBUS_TYPE_G_LIST_OF_STRING, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSetting8021x:phase2-client-cert: * - * Contains the client certificate if used by the EAP method specified in - * the #NMSetting8021x:phase2-auth or #NMSetting8021x:phase2-autheap - * properties. Setting this property directly is discouraged; use the + * Contains the "phase 2" client certificate if used by the EAP method + * specified in the #NMSetting8021x:phase2-auth or + * #NMSetting8021x:phase2-autheap properties. + * + * Certificate data is specified using a "scheme"; two are currently + * supported: blob and path. When using the blob scheme (which is backwards + * compatible with NM 0.7.x) this property should be set to the + * certificate's DER encoded data. When using the path scheme, this property + * should be set to the full UTF-8 encoded path of the certificate, prefixed + * with the string "file://" and ending with a terminating NUL byte. This + * property can be unset even if the EAP method supports CA certificates, + * but this allows man-in-the-middle attacks and is NOT recommended. + * + * Setting this property directly is discouraged; use the * nm_setting_802_1x_set_phase2_client_cert() function instead. **/ g_object_class_install_property (object_class, PROP_PHASE2_CLIENT_CERT, - _nm_param_spec_specialized (NM_SETTING_802_1X_PHASE2_CLIENT_CERT, - "Phase2 client certificate", - "Contains the 'phase 2' client certificate if " - "used by the EAP method specified in the " - "'phase2-auth' or 'phase2-autheap' properties. " - "Certificate data is specified using a 'scheme'; " - "two are currently supported: blob and path. " - "When using the blob scheme (which is backwards " - "compatible with NM 0.7.x) this property should " - "be set to the certificate's DER encoded data. " - "When using the path scheme, this property should " - "be set to the full UTF-8 encoded path of the " - "certificate, prefixed with the string 'file://' " - "and ending with a terminating NULL byte.", - DBUS_TYPE_G_UCHAR_ARRAY, - G_PARAM_READWRITE)); + _nm_param_spec_specialized (NM_SETTING_802_1X_PHASE2_CLIENT_CERT, "", "", + DBUS_TYPE_G_UCHAR_ARRAY, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSetting8021x:password: * - * Password used for EAP authentication methods. If both - * #NMSetting8021x:password and #NMSetting8021x:password-raw are - * specified, #NMSetting8021x:password is preferred. + * UTF-8 encoded password used for EAP authentication methods. If both the + * #NMSetting8021x:password property and the #NMSetting8021x:password-raw + * property are specified, #NMSetting8021x:password is preferred. **/ g_object_class_install_property (object_class, PROP_PASSWORD, - g_param_spec_string (NM_SETTING_802_1X_PASSWORD, - "Password", - "UTF-8 encoded password used for EAP authentication methods.", - NULL, - G_PARAM_READWRITE | NM_SETTING_PARAM_SECRET)); + g_param_spec_string (NM_SETTING_802_1X_PASSWORD, "", "", + NULL, + G_PARAM_READWRITE | NM_SETTING_PARAM_SECRET | + G_PARAM_STATIC_STRINGS)); /** * NMSetting8021x:password-flags: * - * Flags indicating how to handle #NMSetting8021x:password:. + * Flags indicating how to handle the #NMSetting8021x:password property. **/ - g_object_class_install_property (object_class, PROP_PASSWORD_FLAGS, - g_param_spec_uint (NM_SETTING_802_1X_PASSWORD_FLAGS, - "Password Flags", - "Flags indicating how to handle the 802.1x password.", + g_object_class_install_property + (object_class, PROP_PASSWORD_FLAGS, + g_param_spec_uint (NM_SETTING_802_1X_PASSWORD_FLAGS, "", "", NM_SETTING_SECRET_FLAG_NONE, NM_SETTING_SECRET_FLAGS_ALL, NM_SETTING_SECRET_FLAG_NONE, - G_PARAM_READWRITE)); + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSetting8021x:password-raw: * - * Password used for EAP authentication methods delivered as a - * UTF-8-encoded array of bytes. If both #NMSetting8021x:password - * and #NMSetting8021x:password-raw are specified, - * #NMSetting8021x:password is preferred. + * Password used for EAP authentication methods, given as a byte array to + * allow passwords in other encodings than UTF-8 to be used. If both the + * #NMSetting8021x:password property and the #NMSetting8021x:password-raw + * property are specified, #NMSetting8021x:password is preferred. **/ g_object_class_install_property (object_class, PROP_PASSWORD_RAW, - _nm_param_spec_specialized (NM_SETTING_802_1X_PASSWORD_RAW, - "Password byte array", - "Password used for EAP authentication " - "methods, given as a byte array to allow " - "passwords in other encodings than UTF-8 " - "to be used. If both 'password' and " - "'password-raw' are given, 'password' is " - "preferred.", + _nm_param_spec_specialized (NM_SETTING_802_1X_PASSWORD_RAW, "", "", DBUS_TYPE_G_UCHAR_ARRAY, - G_PARAM_READWRITE | NM_SETTING_PARAM_SECRET)); + G_PARAM_READWRITE | NM_SETTING_PARAM_SECRET | + G_PARAM_STATIC_STRINGS)); /** * NMSetting8021x:password-raw-flags: * - * Flags indicating how to handle #NMSetting8021x:password-raw:. + * Flags indicating how to handle the #NMSetting8021x:password-raw property. **/ - g_object_class_install_property (object_class, PROP_PASSWORD_RAW_FLAGS, - g_param_spec_uint (NM_SETTING_802_1X_PASSWORD_RAW_FLAGS, - "Password byte array Flags", - "Flags indicating how to handle the 802.1x password byte array.", + g_object_class_install_property + (object_class, PROP_PASSWORD_RAW_FLAGS, + g_param_spec_uint (NM_SETTING_802_1X_PASSWORD_RAW_FLAGS, "", "", NM_SETTING_SECRET_FLAG_NONE, NM_SETTING_SECRET_FLAGS_ALL, NM_SETTING_SECRET_FLAG_NONE, - G_PARAM_READWRITE)); + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSetting8021x:private-key: * - * Contains the private key if the #NMSetting8021x:eap property is set to - * 'tls'. Setting this property directly is discouraged; use the + * Contains the private key when the #NMSetting8021x:eap property is set to + * "tls". + * + * Key data is specified using a "scheme"; two are currently supported: blob + * and path. When using the blob scheme and private keys, this property + * should be set to the key's encrypted PEM encoded data. When using private + * keys with the path scheme, this property should be set to the full UTF-8 + * encoded path of the key, prefixed with the string "file://" and ending + * with a terminating NUL byte. When using PKCS#12 format private keys and + * the blob scheme, this property should be set to the PKCS#12 data and the + * #NMSetting8021x:private-key-password property must be set to password + * used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files + * and the path scheme, this property should be set to the full UTF-8 + * encoded path of the key, prefixed with the string "file://" and and + * ending with a terminating NUL byte, and as with the blob scheme the + * "private-key-password" property must be set to the password used to + * decode the PKCS#12 private key and certificate. + * + * Setting this property directly is discouraged; use the * nm_setting_802_1x_set_private_key() function instead. * * WARNING: #NMSetting8021x:private-key is not a "secret" property, and thus @@ -3631,146 +3545,106 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class) **/ g_object_class_install_property (object_class, PROP_PRIVATE_KEY, - _nm_param_spec_specialized (NM_SETTING_802_1X_PRIVATE_KEY, - "Private key", - "Contains the private key when the 'eap' property " - "is set to 'tls'. Key data is specified using a " - "'scheme'; two are currently supported: blob and " - "path. When using the blob scheme and private " - "keys, this property should be set to the key's " - "encrypted PEM encoded data. When using private " - "keys with the path scheme, this property should " - "be set to the full UTF-8 encoded path of the key, " - "prefixed with the string 'file://' and ending " - "with a terminating NULL byte. When using " - "PKCS#12 format private keys and the blob " - "scheme, this property should be set to the " - "PKCS#12 data and the 'private-key-password' " - "property must be set to password used to " - "decrypt the PKCS#12 certificate and key. When " - "using PKCS#12 files and the path scheme, this " - "property should be set to the full UTF-8 encoded " - "path of the key, prefixed with the string " - "'file://' and and ending with a terminating NULL " - "byte, and as with the blob scheme the " - "'private-key-password' property must be set to " - "the password used to decode the PKCS#12 private " - "key and certificate.", - DBUS_TYPE_G_UCHAR_ARRAY, - G_PARAM_READWRITE)); + _nm_param_spec_specialized (NM_SETTING_802_1X_PRIVATE_KEY, "", "", + DBUS_TYPE_G_UCHAR_ARRAY, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSetting8021x:private-key-password: * - * The password used to decrypt the private key specified in - * #NMSetting8021x:private-key when the private key either uses the path - * scheme, or if the private key is a PKCS#12 format key. Setting this + * The password used to decrypt the private key specified in the + * #NMSetting8021x:private-key property when the private key either uses the + * path scheme, or if the private key is a PKCS#12 format key. Setting this * property directly is not generally necessary except when returning * secrets to NetworkManager; it is generally set automatically when setting * the private key by the nm_setting_802_1x_set_private_key() function. **/ g_object_class_install_property (object_class, PROP_PRIVATE_KEY_PASSWORD, - g_param_spec_string (NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD, - "Private key password", - "The password used to decrypt the private key " - "specified in the 'private-key' property when the " - "private key either uses the path scheme, or if the " - "private key is a PKCS#12 format key.", - NULL, - G_PARAM_READWRITE | NM_SETTING_PARAM_SECRET)); + g_param_spec_string (NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD, "", "", + NULL, + G_PARAM_READWRITE | NM_SETTING_PARAM_SECRET | + G_PARAM_STATIC_STRINGS)); /** * NMSetting8021x:private-key-password-flags: * - * Flags indicating how to handle #NMSetting8021x:private-key-password:. + * Flags indicating how to handle the #NMSetting8021x:private-key-password + * property. **/ - g_object_class_install_property (object_class, PROP_PRIVATE_KEY_PASSWORD_FLAGS, - g_param_spec_uint (NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD_FLAGS, - "Private Key Password Flags", - "Flags indicating how to handle the 802.1x private " - "key password.", + g_object_class_install_property + (object_class, PROP_PRIVATE_KEY_PASSWORD_FLAGS, + g_param_spec_uint (NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD_FLAGS, "", "", NM_SETTING_SECRET_FLAG_NONE, NM_SETTING_SECRET_FLAGS_ALL, NM_SETTING_SECRET_FLAG_NONE, - G_PARAM_READWRITE)); + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSetting8021x:phase2-private-key: * - * Private key data used by "phase 2" inner authentication methods. + * Contains the "phase 2" inner private key when the + * #NMSetting8021x:phase2-auth or #NMSetting8021x:phase2-autheap property is + * set to "tls". + * + * Key data is specified using a "scheme"; two are currently supported: blob + * and path. When using the blob scheme and private keys, this property + * should be set to the key's encrypted PEM encoded data. When using private + * keys with the path scheme, this property should be set to the full UTF-8 + * encoded path of the key, prefixed with the string "file://" and ending + * with a terminating NUL byte. When using PKCS#12 format private keys and + * the blob scheme, this property should be set to the PKCS#12 data and the + * #NMSetting8021x:phase2-private-key-password property must be set to + * password used to decrypt the PKCS#12 certificate and key. When using + * PKCS#12 files and the path scheme, this property should be set to the + * full UTF-8 encoded path of the key, prefixed with the string "file://" + * and and ending with a terminating NUL byte, and as with the blob scheme + * the #NMSetting8021x:phase2-private-key-password property must be set to + * the password used to decode the PKCS#12 private key and certificate. * - * Contains the "phase 2" inner private key if the #NMSetting8021x:phase2-auth - * or #NMSetting8021x:phase2-autheap property is set to 'tls'. Setting this - * property directly is discouraged; use the + * Setting this property directly is discouraged; use the * nm_setting_802_1x_set_phase2_private_key() function instead. **/ g_object_class_install_property (object_class, PROP_PHASE2_PRIVATE_KEY, - _nm_param_spec_specialized (NM_SETTING_802_1X_PHASE2_PRIVATE_KEY, - "Phase2 private key", - "Contains the 'phase 2' inner private key when " - "the 'phase2-auth' or 'phase2-autheap' property " - "is set to 'tls'. Key data is specified using a " - "'scheme'; two are currently supported: blob and " - "path. When using the blob scheme and private " - "keys, this property should be set to the key's " - "encrypted PEM encoded data. When using private " - "keys with the path scheme, this property should " - "be set to the full UTF-8 encoded path of the key, " - "prefixed with the string 'file://' and ending " - "with a terminating NULL byte. When using " - "PKCS#12 format private keys and the blob " - "scheme, this property should be set to the " - "PKCS#12 data and the 'phase2-private-key-password' " - "property must be set to password used to " - "decrypt the PKCS#12 certificate and key. When " - "using PKCS#12 files and the path scheme, this " - "property should be set to the full UTF-8 encoded " - "path of the key, prefixed with the string " - "'file://' and and ending with a terminating NULL " - "byte, and as with the blob scheme the " - "'phase2-private-key-password' property must be " - "set to the password used to decode the PKCS#12 " - "private key and certificate.", - DBUS_TYPE_G_UCHAR_ARRAY, - G_PARAM_READWRITE)); + _nm_param_spec_specialized (NM_SETTING_802_1X_PHASE2_PRIVATE_KEY, "", "", + DBUS_TYPE_G_UCHAR_ARRAY, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSetting8021x:phase2-private-key-password: * - * The password used to decrypt the private key specified in - * #NMSetting8021x:phase2-private-key when the private key either uses the - * path scheme, or if the private key is a PKCS#12 format key. Setting this - * property directly is not generally necessary except when returning - * secrets to NetworkManager; it is generally set automatically when setting - * the private key by the nm_setting_802_1x_set_phase2_private_key() function. + * The password used to decrypt the "phase 2" private key specified in the + * #NMSetting8021x:phase2-private-key property when the private key either + * uses the path scheme, or is a PKCS#12 format key. Setting this property + * directly is not generally necessary except when returning secrets to + * NetworkManager; it is generally set automatically when setting the + * private key by the nm_setting_802_1x_set_phase2_private_key() function. **/ g_object_class_install_property (object_class, PROP_PHASE2_PRIVATE_KEY_PASSWORD, - g_param_spec_string (NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD, - "Phase2 private key password", - "The password used to decrypt the 'phase 2' private " - "key specified in the 'private-key' property when the " - "phase2 private key either uses the path scheme, or " - "if the phase2 private key is a PKCS#12 format key.", - NULL, - G_PARAM_READWRITE | NM_SETTING_PARAM_SECRET)); + g_param_spec_string (NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD, "", "", + NULL, + G_PARAM_READWRITE | NM_SETTING_PARAM_SECRET | + G_PARAM_STATIC_STRINGS)); /** * NMSetting8021x:phase2-private-key-password-flags: * - * Flags indicating how to handle #NMSetting8021x:phase2-private-key-password:. + * Flags indicating how to handle the + * #NMSetting8021x:phase2-private-key-password property. **/ - g_object_class_install_property (object_class, PROP_PHASE2_PRIVATE_KEY_PASSWORD_FLAGS, - g_param_spec_uint (NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD_FLAGS, - "Phase2 Private Key Password Flags", - "Flags indicating how to handle the 802.1x phase2 " - "private key password.", + g_object_class_install_property + (object_class, PROP_PHASE2_PRIVATE_KEY_PASSWORD_FLAGS, + g_param_spec_uint (NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD_FLAGS, "", "", NM_SETTING_SECRET_FLAG_NONE, NM_SETTING_SECRET_FLAGS_ALL, NM_SETTING_SECRET_FLAG_NONE, - G_PARAM_READWRITE)); + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSetting8021x:pin: @@ -3779,49 +3653,41 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class) **/ g_object_class_install_property (object_class, PROP_PIN, - g_param_spec_string (NM_SETTING_802_1X_PIN, - "PIN", - "PIN used for EAP authentication methods.", + g_param_spec_string (NM_SETTING_802_1X_PIN, "", "", NULL, - G_PARAM_READWRITE | NM_SETTING_PARAM_SECRET)); + G_PARAM_READWRITE | NM_SETTING_PARAM_SECRET | + G_PARAM_STATIC_STRINGS)); /** * NMSetting8021x:pin-flags: * - * Flags indicating how to handle #NMSetting8021x:pin:. + * Flags indicating how to handle the #NMSetting8021x:pin property. **/ - g_object_class_install_property (object_class, PROP_PIN_FLAGS, - g_param_spec_uint (NM_SETTING_802_1X_PIN_FLAGS, - "PIN Flags", - "Flags indicating how to handle the 802.1x PIN.", + g_object_class_install_property + (object_class, PROP_PIN_FLAGS, + g_param_spec_uint (NM_SETTING_802_1X_PIN_FLAGS, "", "", NM_SETTING_SECRET_FLAG_NONE, NM_SETTING_SECRET_FLAGS_ALL, NM_SETTING_SECRET_FLAG_NONE, - G_PARAM_READWRITE)); + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSetting8021x:system-ca-certs: * - * When TRUE, overrides #NMSetting8021x:ca-path and + * When %TRUE, overrides the #NMSetting8021x:ca-path and * #NMSetting8021x:phase2-ca-path properties using the system CA directory * specified at configure time with the --system-ca-path switch. The * certificates in this directory are added to the verification chain in - * addition to any certificates specified by the #NMSetting8021x:ca-cert - * and #NMSetting8021x:phase2-ca-cert properties. + * addition to any certificates specified by the #NMSetting8021x:ca-cert and + * #NMSetting8021x:phase2-ca-cert properties. **/ g_object_class_install_property (object_class, PROP_SYSTEM_CA_CERTS, - g_param_spec_boolean (NM_SETTING_802_1X_SYSTEM_CA_CERTS, - "Use system CA certificates", - "When TRUE, overrides 'ca-path' and 'phase2-ca-path' " - "properties using the system CA directory " - "specified at configure time with the " - "--system-ca-path switch. The certificates in " - "this directory are added to the verification " - "chain in addition to any certificates specified " - "by the 'ca-cert' and 'phase2-ca-cert' properties.", - FALSE, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + g_param_spec_boolean (NM_SETTING_802_1X_SYSTEM_CA_CERTS, "", "", + FALSE, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); /* Initialize crypto lbrary. */ if (!nm_utils_init (&error)) { @@ -3829,5 +3695,4 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class) error->code, error->message); g_error_free (error); } - } diff --git a/libnm-util/nm-setting-adsl.c b/libnm-util/nm-setting-adsl.c index 50b0b225af..d1629166d7 100644 --- a/libnm-util/nm-setting-adsl.c +++ b/libnm-util/nm-setting-adsl.c @@ -387,11 +387,10 @@ nm_setting_adsl_class_init (NMSettingAdslClass *setting_class) **/ g_object_class_install_property (object_class, PROP_USERNAME, - g_param_spec_string (NM_SETTING_ADSL_USERNAME, - "Username", - "Username used to authenticate with the pppoa service.", - NULL, - G_PARAM_READWRITE)); + g_param_spec_string (NM_SETTING_ADSL_USERNAME, "", "", + NULL, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingAdsl:password: @@ -400,75 +399,70 @@ nm_setting_adsl_class_init (NMSettingAdslClass *setting_class) **/ g_object_class_install_property (object_class, PROP_PASSWORD, - g_param_spec_string (NM_SETTING_ADSL_PASSWORD, - "Password", - "Password used to authenticate with the pppoa service.", - NULL, - G_PARAM_READWRITE | NM_SETTING_PARAM_SECRET)); + g_param_spec_string (NM_SETTING_ADSL_PASSWORD, "", "", + NULL, + G_PARAM_READWRITE | NM_SETTING_PARAM_SECRET | + G_PARAM_STATIC_STRINGS)); /** * NMSettingAdsl:password-flags: * - * Flags indicating how to handle #NMSettingAdsl:password:. + * Flags indicating how to handle the #NMSettingAdsl:password property. **/ - g_object_class_install_property (object_class, PROP_PASSWORD_FLAGS, - g_param_spec_uint (NM_SETTING_ADSL_PASSWORD_FLAGS, - "Password Flags", - "Flags indicating how to handle the ADSL password.", + g_object_class_install_property + (object_class, PROP_PASSWORD_FLAGS, + g_param_spec_uint (NM_SETTING_ADSL_PASSWORD_FLAGS, "", "", NM_SETTING_SECRET_FLAG_NONE, NM_SETTING_SECRET_FLAGS_ALL, NM_SETTING_SECRET_FLAG_NONE, - G_PARAM_READWRITE)); + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingAdsl:protocol: * - * ADSL connection protocol, can be pppoa, pppoe or ipoatm. + * ADSL connection protocol. Can be "pppoa", "pppoe" or "ipoatm". **/ g_object_class_install_property (object_class, PROP_PROTOCOL, - g_param_spec_string (NM_SETTING_ADSL_PROTOCOL, - "Protocol", - "ADSL connection protocol.", - NULL, - G_PARAM_READWRITE)); + g_param_spec_string (NM_SETTING_ADSL_PROTOCOL, "", "", + NULL, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingAdsl:encapsulation: * - * ADSL connection encapsulation, can be vcmux or llc. + * Encapsulation of ADSL connection. Can be "vcmux" or "llc". **/ g_object_class_install_property (object_class, PROP_ENCAPSULATION, - g_param_spec_string (NM_SETTING_ADSL_ENCAPSULATION, - "Encapsulation", - "Encapsulation of ADSL connection", - NULL, - G_PARAM_READWRITE)); + g_param_spec_string (NM_SETTING_ADSL_ENCAPSULATION, "", "", + NULL, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingAdsl:vpi: * - * ADSL connection vpi. + * VPI of ADSL connection **/ g_object_class_install_property (object_class, PROP_VPI, - g_param_spec_uint (NM_SETTING_ADSL_VPI, - "VPI", - "VPI of ADSL connection", - 0, 65536, 0, - G_PARAM_READWRITE)); + g_param_spec_uint (NM_SETTING_ADSL_VPI, "", "", + 0, 65536, 0, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingAdsl:vci: * - * ADSL connection vci. + * VCI of ADSL connection **/ g_object_class_install_property (object_class, PROP_VCI, - g_param_spec_uint (NM_SETTING_ADSL_VCI, - "VCI", - "VCI of ADSL connection", - 0, 65536, 0, - G_PARAM_READWRITE)); + g_param_spec_uint (NM_SETTING_ADSL_VCI, "", "", + 0, 65536, 0, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); } diff --git a/libnm-util/nm-setting-bluetooth.c b/libnm-util/nm-setting-bluetooth.c index d568c01e36..7c2566cad4 100644 --- a/libnm-util/nm-setting-bluetooth.c +++ b/libnm-util/nm-setting-bluetooth.c @@ -279,26 +279,21 @@ nm_setting_bluetooth_class_init (NMSettingBluetoothClass *setting_class) **/ g_object_class_install_property (object_class, PROP_BDADDR, - _nm_param_spec_specialized (NM_SETTING_BLUETOOTH_BDADDR, - "Bluetooth address", - "The Bluetooth address of the device", + _nm_param_spec_specialized (NM_SETTING_BLUETOOTH_BDADDR, "", "", DBUS_TYPE_G_UCHAR_ARRAY, - G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE)); + G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingBluetooth:type: * - * Either 'dun' for Dial-Up Networking connections or 'panu' for Personal + * Either "dun" for Dial-Up Networking connections or "panu" for Personal * Area Networking connections to devices supporting the NAP profile. **/ g_object_class_install_property (object_class, PROP_TYPE, - g_param_spec_string (NM_SETTING_BLUETOOTH_TYPE, - "Connection type", - "Either '" NM_SETTING_BLUETOOTH_TYPE_DUN "' for " - "Dial-Up Networking connections or " - "'" NM_SETTING_BLUETOOTH_TYPE_PANU "' for " - "Personal Area Networking connections.", - NULL, - G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE)); + g_param_spec_string (NM_SETTING_BLUETOOTH_TYPE, "", "", + NULL, + G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); } diff --git a/libnm-util/nm-setting-bond.c b/libnm-util/nm-setting-bond.c index c17fdbdcd5..86e8bcff43 100644 --- a/libnm-util/nm-setting-bond.c +++ b/libnm-util/nm-setting-bond.c @@ -795,27 +795,22 @@ nm_setting_bond_class_init (NMSettingBondClass *setting_class) **/ g_object_class_install_property (object_class, PROP_INTERFACE_NAME, - g_param_spec_string (NM_SETTING_BOND_INTERFACE_NAME, - "InterfaceName", - "The name of the virtual in-kernel bonding network interface", + g_param_spec_string (NM_SETTING_BOND_INTERFACE_NAME, "", "", NULL, - G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE)); + G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingBond:options: * - * Dictionary of key/value pairs of bonding options. Both keys - * and values must be strings. Option names must contain only - * alphanumeric characters (ie, [a-zA-Z0-9]). + * Dictionary of key/value pairs of bonding options. Both keys and values + * must be strings. Option names must contain only alphanumeric characters + * (ie, [a-zA-Z0-9]). **/ g_object_class_install_property (object_class, PROP_OPTIONS, - _nm_param_spec_specialized (NM_SETTING_BOND_OPTIONS, - "Options", - "Dictionary of key/value pairs of bonding " - "options. Both keys and values must be " - "strings. Option names must contain only " - "alphanumeric characters (ie, [a-zA-Z0-9]).", + _nm_param_spec_specialized (NM_SETTING_BOND_OPTIONS, "", "", DBUS_TYPE_G_MAP_OF_STRING, - G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE)); + G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); } diff --git a/libnm-util/nm-setting-bridge-port.c b/libnm-util/nm-setting-bridge-port.c index 0a82fa692b..7430f36c2f 100644 --- a/libnm-util/nm-setting-bridge-port.c +++ b/libnm-util/nm-setting-bridge-port.c @@ -264,43 +264,38 @@ nm_setting_bridge_port_class_init (NMSettingBridgePortClass *setting_class) **/ g_object_class_install_property (object_class, PROP_PRIORITY, - g_param_spec_uint (NM_SETTING_BRIDGE_PORT_PRIORITY, - "Priority", - "The Spanning Tree Protocol (STP) priority of this bridge port", + g_param_spec_uint (NM_SETTING_BRIDGE_PORT_PRIORITY, "", "", 0, BR_MAX_PORT_PRIORITY, BR_DEF_PRIORITY, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_INFERRABLE)); + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingBridgePort:path-cost: * - * The Spanning Tree Protocol (STP) port cost for destinations via this port. + * The Spanning Tree Protocol (STP) port cost for destinations via this + * port. * * Since: 0.9.8 **/ - g_object_class_install_property - (object_class, PROP_PATH_COST, - g_param_spec_uint (NM_SETTING_BRIDGE_PORT_PATH_COST, - "Path Cost", - "The Spanning Tree Protocol (STP) port cost for " - "destinations via this port.", + g_object_class_install_property + (object_class, PROP_PATH_COST, + g_param_spec_uint (NM_SETTING_BRIDGE_PORT_PATH_COST, "", "", 0, BR_MAX_PATH_COST, 100, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_INFERRABLE)); + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingBridgePort:hairpin-mode: * - * Enables or disabled 'hairpin mode' for the port, which allows frames to + * Enables or disabled "hairpin mode" for the port, which allows frames to * be sent back out through the port the frame was received on. * * Since: 0.9.8 **/ - g_object_class_install_property - (object_class, PROP_HAIRPIN_MODE, - g_param_spec_boolean (NM_SETTING_BRIDGE_PORT_HAIRPIN_MODE, - "Hairpin Mode", - "Enables or disabled 'hairpin mode' for the " - "port, which allows frames to be sent back out " - "through the port the frame was received on.", + g_object_class_install_property + (object_class, PROP_HAIRPIN_MODE, + g_param_spec_boolean (NM_SETTING_BRIDGE_PORT_HAIRPIN_MODE, "", "", FALSE, - G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE)); + G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); } diff --git a/libnm-util/nm-setting-bridge.c b/libnm-util/nm-setting-bridge.c index f463259ff7..99951bc1a5 100644 --- a/libnm-util/nm-setting-bridge.c +++ b/libnm-util/nm-setting-bridge.c @@ -462,34 +462,32 @@ nm_setting_bridge_class_init (NMSettingBridgeClass *setting_class) /** * NMSettingBridge:interface-name: * - * The name of the virtual in-kernel briding network interface + * The name of the virtual in-kernel bridging network interface * * Since: 0.9.8 **/ g_object_class_install_property (object_class, PROP_INTERFACE_NAME, - g_param_spec_string (NM_SETTING_BRIDGE_INTERFACE_NAME, - "InterfaceName", - "The name of the virtual in-kernel bridging network interface", + g_param_spec_string (NM_SETTING_BRIDGE_INTERFACE_NAME, "", "", NULL, - G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE)); + G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingBridge:mac-address: * - * If specified, the MAC address of bridge. When creating a new bridge, this MAC address - * will be set. When matching an existing (outside NetworkManager created) bridge, this - * MAC address must match. + * If specified, the MAC address of bridge. When creating a new bridge, this + * MAC address will be set. When matching an existing (outside + * NetworkManager created) bridge, this MAC address must match. * * Since: 0.9.10 **/ g_object_class_install_property - (object_class, PROP_MAC_ADDRESS, - _nm_param_spec_specialized (NM_SETTING_BRIDGE_MAC_ADDRESS, - "MAC Address", - "The MAC address of the bridge", - DBUS_TYPE_G_UCHAR_ARRAY, - G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE)); + (object_class, PROP_MAC_ADDRESS, + _nm_param_spec_specialized (NM_SETTING_BRIDGE_MAC_ADDRESS, "", "", + DBUS_TYPE_G_UCHAR_ARRAY, + G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingBridge:stp: @@ -498,14 +496,12 @@ nm_setting_bridge_class_init (NMSettingBridgeClass *setting_class) * * Since: 0.9.8 **/ - g_object_class_install_property - (object_class, PROP_STP, - g_param_spec_boolean (NM_SETTING_BRIDGE_STP, - "STP", - "Controls whether Spanning Tree Protocol (STP) " - "is enabled for this bridge.", - TRUE, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_INFERRABLE)); + g_object_class_install_property + (object_class, PROP_STP, + g_param_spec_boolean (NM_SETTING_BRIDGE_STP, "", "", + TRUE, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingBridge:priority: @@ -516,16 +512,12 @@ nm_setting_bridge_class_init (NMSettingBridgeClass *setting_class) * * Since: 0.9.8 **/ - g_object_class_install_property - (object_class, PROP_PRIORITY, - g_param_spec_uint (NM_SETTING_BRIDGE_PRIORITY, - "Priority", - "Sets the Spanning Tree Protocol (STP) priority " - "for this bridge. Lower values are 'better'; the " - "lowest priority bridge will be elected the root " - "bridge.", - 0, G_MAXUINT16, 0x8000, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_INFERRABLE)); + g_object_class_install_property + (object_class, PROP_PRIORITY, + g_param_spec_uint (NM_SETTING_BRIDGE_PRIORITY, "", "", + 0, G_MAXUINT16, 0x8000, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingBridge:forward-delay: @@ -534,14 +526,12 @@ nm_setting_bridge_class_init (NMSettingBridgeClass *setting_class) * * Since: 0.9.8 **/ - g_object_class_install_property - (object_class, PROP_FORWARD_DELAY, - g_param_spec_uint (NM_SETTING_BRIDGE_FORWARD_DELAY, - "ForwardDelay", - "The Spanning Tree Protocol (STP) forwarding " - "delay, in seconds.", - 0, BR_MAX_FORWARD_DELAY, 15, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_INFERRABLE)); + g_object_class_install_property + (object_class, PROP_FORWARD_DELAY, + g_param_spec_uint (NM_SETTING_BRIDGE_FORWARD_DELAY, "", "", + 0, BR_MAX_FORWARD_DELAY, 15, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingBridge:hello-time: @@ -550,14 +540,12 @@ nm_setting_bridge_class_init (NMSettingBridgeClass *setting_class) * * Since: 0.9.8 **/ - g_object_class_install_property - (object_class, PROP_HELLO_TIME, - g_param_spec_uint (NM_SETTING_BRIDGE_HELLO_TIME, - "HelloTime", - "The Spanning Tree Protocol (STP) hello time, in " - "seconds.", - 0, BR_MAX_HELLO_TIME, 2, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_INFERRABLE)); + g_object_class_install_property + (object_class, PROP_HELLO_TIME, + g_param_spec_uint (NM_SETTING_BRIDGE_HELLO_TIME, "", "", + 0, BR_MAX_HELLO_TIME, 2, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingBridge:max-age: @@ -566,28 +554,25 @@ nm_setting_bridge_class_init (NMSettingBridgeClass *setting_class) * * Since: 0.9.8 **/ - g_object_class_install_property - (object_class, PROP_MAX_AGE, - g_param_spec_uint (NM_SETTING_BRIDGE_MAX_AGE, - "MaxAge", - "The Spanning Tree Protocol (STP) maximum message " - "age, in seconds.", - 0, BR_MAX_MAX_AGE, 20, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_INFERRABLE)); + g_object_class_install_property + (object_class, PROP_MAX_AGE, + g_param_spec_uint (NM_SETTING_BRIDGE_MAX_AGE, "", "", + 0, BR_MAX_MAX_AGE, 20, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingBridge:ageing-time: * - * The ethernet MAC address aging time, in seconds. + * The Ethernet MAC address aging time, in seconds. * * Since: 0.9.8 **/ - g_object_class_install_property - (object_class, PROP_AGEING_TIME, - g_param_spec_uint (NM_SETTING_BRIDGE_AGEING_TIME, - "AgeingTime", - "The ethernet MAC address aging time, in seconds.", - 0, BR_MAX_AGEING_TIME, 300, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_INFERRABLE)); + g_object_class_install_property + (object_class, PROP_AGEING_TIME, + g_param_spec_uint (NM_SETTING_BRIDGE_AGEING_TIME, "", "", + 0, BR_MAX_AGEING_TIME, 300, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); } diff --git a/libnm-util/nm-setting-cdma.c b/libnm-util/nm-setting-cdma.c index 8b4752d146..ab62d1fc96 100644 --- a/libnm-util/nm-setting-cdma.c +++ b/libnm-util/nm-setting-cdma.c @@ -308,14 +308,10 @@ nm_setting_cdma_class_init (NMSettingCdmaClass *setting_class) **/ g_object_class_install_property (object_class, PROP_NUMBER, - g_param_spec_string (NM_SETTING_CDMA_NUMBER, - "Number", - "Number to dial when establishing a PPP data session " - "with the CDMA-based mobile broadband network. If not " - "specified, the default number (#777) is used when " - "required.", - NULL, - G_PARAM_READWRITE)); + g_param_spec_string (NM_SETTING_CDMA_NUMBER, "", "", + NULL, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingCdma:username: @@ -326,13 +322,10 @@ nm_setting_cdma_class_init (NMSettingCdmaClass *setting_class) **/ g_object_class_install_property (object_class, PROP_USERNAME, - g_param_spec_string (NM_SETTING_CDMA_USERNAME, - "Username", - "Username used to authenticate with the network, if " - "required. Note that many providers do not require " - "a username or accept any username.", - NULL, - G_PARAM_READWRITE)); + g_param_spec_string (NM_SETTING_CDMA_USERNAME, "", "", + NULL, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingCdma:password: @@ -343,25 +336,22 @@ nm_setting_cdma_class_init (NMSettingCdmaClass *setting_class) **/ g_object_class_install_property (object_class, PROP_PASSWORD, - g_param_spec_string (NM_SETTING_CDMA_PASSWORD, - "Password", - "Password used to authenticate with the network, if " - "required. Note that many providers do not require " - "a password or accept any password.", - NULL, - G_PARAM_READWRITE | NM_SETTING_PARAM_SECRET)); + g_param_spec_string (NM_SETTING_CDMA_PASSWORD, "", "", + NULL, + G_PARAM_READWRITE | NM_SETTING_PARAM_SECRET | + G_PARAM_STATIC_STRINGS)); /** * NMSettingCdma:password-flags: * - * Flags indicating how to handle #NMSettingCdma:password:. + * Flags indicating how to handle the #NMSettingCdma:password property. **/ - g_object_class_install_property (object_class, PROP_PASSWORD_FLAGS, - g_param_spec_uint (NM_SETTING_CDMA_PASSWORD_FLAGS, - "Password Flags", - "Flags indicating how to handle the CDMA password.", + g_object_class_install_property + (object_class, PROP_PASSWORD_FLAGS, + g_param_spec_uint (NM_SETTING_CDMA_PASSWORD_FLAGS, "", "", NM_SETTING_SECRET_FLAG_NONE, NM_SETTING_SECRET_FLAGS_ALL, NM_SETTING_SECRET_FLAG_NONE, - G_PARAM_READWRITE)); + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); } diff --git a/libnm-util/nm-setting-connection.c b/libnm-util/nm-setting-connection.c index 8e735247fa..b35b0fca10 100644 --- a/libnm-util/nm-setting-connection.c +++ b/libnm-util/nm-setting-connection.c @@ -1098,146 +1098,98 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class) /** * NMSettingConnection:id: * - * A human readable unique idenfier for the connection, like "Work WiFi" or - * "T-Mobile 3G". + * A human readable unique identifier for the connection, like "Work Wi-Fi" + * or "T-Mobile 3G". **/ g_object_class_install_property (object_class, PROP_ID, - g_param_spec_string (NM_SETTING_CONNECTION_ID, - "ID", - "User-readable connection identifier/name. Must be " - "one or more characters and may change over the lifetime " - "of the connection if the user decides to rename it.", - NULL, - G_PARAM_READWRITE | NM_SETTING_PARAM_FUZZY_IGNORE)); + g_param_spec_string (NM_SETTING_CONNECTION_ID, "", "", + NULL, + G_PARAM_READWRITE | NM_SETTING_PARAM_FUZZY_IGNORE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingConnection:uuid: * - * A universally unique idenfier for the connection, for example generated - * with libuuid. Should be assigned when the connection is created, and + * A universally unique identifier for the connection, for example generated + * with libuuid. It should be assigned when the connection is created, and * never changed as long as the connection still applies to the same - * network. For example, should not be changed when the - * #NMSettingConnection:id or #NMSettingIP4Config changes, but might need - * to be re-created when the WiFi SSID, mobile broadband network provider, - * or #NMSettingConnection:type changes. + * network. For example, it should not be changed when the + * #NMSettingConnection:id property or #NMSettingIP4Config changes, but + * might need to be re-created when the Wi-Fi SSID, mobile broadband network + * provider, or #NMSettingConnection:type property changes. * - * The UUID must be in the format '2815492f-7e56-435e-b2e9-246bd7cdc664' - * (ie, contains only hexadecimal characters and '-'). A suitable UUID may + * The UUID must be in the format "2815492f-7e56-435e-b2e9-246bd7cdc664" + * (ie, contains only hexadecimal characters and "-"). A suitable UUID may * be generated by nm_utils_uuid_generate() or * nm_utils_uuid_generate_from_string(). **/ g_object_class_install_property (object_class, PROP_UUID, - g_param_spec_string (NM_SETTING_CONNECTION_UUID, - "UUID", - "Universally unique connection identifier. Must be " - "in the format '2815492f-7e56-435e-b2e9-246bd7cdc664' " - "(ie, contains only hexadecimal characters and '-'). " - "The UUID should be assigned when the connection is " - "created and never changed as long as the connection " - "still applies to the same network. For example, " - "it should not be changed when the user changes the " - "connection's 'id', but should be recreated when the " - "WiFi SSID, mobile broadband network provider, or the " - "connection type changes.", - NULL, - G_PARAM_READWRITE | NM_SETTING_PARAM_FUZZY_IGNORE)); + g_param_spec_string (NM_SETTING_CONNECTION_UUID, "", "", + NULL, + G_PARAM_READWRITE | NM_SETTING_PARAM_FUZZY_IGNORE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingConnection:interface-name: * - * The name of the network interface this connection is bound to. If - * not set, then the connection can be attached to any interface of the + * The name of the network interface this connection is bound to. If not + * set, then the connection can be attached to any interface of the * appropriate type (subject to restrictions imposed by other settings). * - * For connection types where interface names cannot easily be - * made persistent (e.g. mobile broadband or USB ethernet), this - * property should not be used. Setting this property restricts - * the interfaces a connection can be used with, and if interface - * names change or are reordered the connection may be applied to - * the wrong interface. + * For connection types where interface names cannot easily be made + * persistent (e.g. mobile broadband or USB Ethernet), this property should + * not be used. Setting this property restricts the interfaces a connection + * can be used with, and if interface names change or are reordered the + * connection may be applied to the wrong interface. * * Since: 0.9.10 **/ g_object_class_install_property (object_class, PROP_INTERFACE_NAME, - g_param_spec_string (NM_SETTING_CONNECTION_INTERFACE_NAME, - "Interface name", - "Interface name this connection is bound to. " - "If not set, then the connection can be attached " - "to any interface of the appropriate type (subject " - "to restrictions imposed by other settings). For " - "connection types where interface names cannot easily " - "be made persistent (e.g. mobile broadband or USB " - "ethernet), this property should not be used. Setting " - "this property restricts the interfaces a connection can " - "be used with, and if interface names change or are " - "reordered the connection may be applied to the wrong " - "interface.", + g_param_spec_string (NM_SETTING_CONNECTION_INTERFACE_NAME, "", "", NULL, - G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE)); + G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingConnection:type: * - * The general hardware type of the device used for the network connection, - * contains the name of the #NMSetting object that describes that hardware - * type's parameters. For example, for WiFi devices, the name of the - * #NMSettingWireless setting. + * Base type of the connection. For hardware-dependent connections, should + * contain the setting name of the hardware-type specific setting (ie, + * "802-3-ethernet" or "802-11-wireless" or "bluetooth", etc), and for + * non-hardware dependent connections like VPN or otherwise, should contain + * the setting name of that setting type (ie, "vpn" or "bridge", etc). **/ g_object_class_install_property (object_class, PROP_TYPE, - g_param_spec_string (NM_SETTING_CONNECTION_TYPE, - "Type", - "Base type of the connection. For hardware-dependent " - "connections, should contain the setting name of the " - "hardware-type specific setting (ie, '802-3-ethernet' " - "or '802-11-wireless' or 'bluetooth', etc), and for " - "non-hardware dependent connections like VPN or " - "otherwise, should contain the setting name of that " - "setting type (ie, 'vpn' or 'bridge', etc).", - NULL, - G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE)); + g_param_spec_string (NM_SETTING_CONNECTION_TYPE, "", "", + NULL, + G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingConnection:permissions: * * An array of strings defining what access a given user has to this - * connection. If this is NULL or empty, all users are allowed to access + * connection. If this is %NULL or empty, all users are allowed to access * this connection. Otherwise a user is allowed to access this connection * if and only if they are in this list. Each entry is of the form - * "[type]:[id]:[reserved]", for example: - * - * user:dcbw:blah + * "[type]:[id]:[reserved]"; for example, "user:dcbw:blah". * - * At this time only the 'user' [type] is allowed. Any other values are + * At this time only the "user" [type] is allowed. Any other values are * ignored and reserved for future use. [id] is the username that this - * permission refers to, which may not contain the ':' character. Any - * [reserved] information present must be ignored and is reserved for - * future use. All of [type], [id], and [reserved] must be valid UTF-8. + * permission refers to, which may not contain the ":" character. Any + * [reserved] information present must be ignored and is reserved for future + * use. All of [type], [id], and [reserved] must be valid UTF-8. */ g_object_class_install_property (object_class, PROP_PERMISSIONS, - _nm_param_spec_specialized (NM_SETTING_CONNECTION_PERMISSIONS, - "Permissions", - "An array of strings defining what access a given " - "user has to this connection. If this is NULL or " - "empty, all users are allowed to access this " - "connection. Otherwise a user is allowed to access " - "this connection if and only if they are in this " - "array. Each entry is of the form " - "\"[type]:[id]:[reserved]\", for example: " - "\"user:dcbw:blah\" At this time only the 'user' " - "[type] is allowed. Any other values are ignored and " - "reserved for future use. [id] is the username that " - "this permission refers to, which may not contain the " - "':' character. Any [reserved] information (if " - "present) must be ignored and is reserved for future " - "use. All of [type], [id], and [reserved] must be " - "valid UTF-8.", - DBUS_TYPE_G_LIST_OF_STRING, - G_PARAM_READWRITE)); + _nm_param_spec_specialized (NM_SETTING_CONNECTION_PERMISSIONS, "", "", + DBUS_TYPE_G_LIST_OF_STRING, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingConnection:autoconnect: @@ -1245,76 +1197,61 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class) * Whether or not the connection should be automatically connected by * NetworkManager when the resources for the connection are available. * %TRUE to automatically activate the connection, %FALSE to require manual - * intervention to activate the connection. Defaults to %TRUE. + * intervention to activate the connection. **/ g_object_class_install_property (object_class, PROP_AUTOCONNECT, - g_param_spec_boolean (NM_SETTING_CONNECTION_AUTOCONNECT, - "Autoconnect", - "If TRUE, NetworkManager will activate this connection " - "when its network resources are available. If FALSE, " - "the connection must be manually activated by the user " - "or some other mechanism.", - TRUE, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_FUZZY_IGNORE)); + g_param_spec_boolean (NM_SETTING_CONNECTION_AUTOCONNECT, "", "", + TRUE, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_FUZZY_IGNORE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingConnection:timestamp: * * The time, in seconds since the Unix Epoch, that the connection was last * _successfully_ fully activated. + * + * NetworkManager updates the connection timestamp periodically when the + * connection is active to ensure that an active connection has the latest + * timestamp. The property is only meant for reading (changes to this + * property will not be preserved). **/ g_object_class_install_property (object_class, PROP_TIMESTAMP, - g_param_spec_uint64 (NM_SETTING_CONNECTION_TIMESTAMP, - "Timestamp", - "Timestamp (in seconds since the Unix Epoch) that the " - "connection was last successfully activated. NetworkManager " - "updates the connection timestamp periodically when the " - "connection is active to ensure that an active connection " - "has the latest timestamp. The property is only meant for " - "reading (changes to this property will not be preserved).", + g_param_spec_uint64 (NM_SETTING_CONNECTION_TIMESTAMP, "", "", 0, G_MAXUINT64, 0, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_FUZZY_IGNORE)); + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_FUZZY_IGNORE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingConnection:read-only: * * %FALSE if the connection can be modified using the provided settings - * service's D-Bus interface with the right privileges, or %TRUE - * if the connection is read-only and cannot be modified. + * service's D-Bus interface with the right privileges, or %TRUE if the + * connection is read-only and cannot be modified. **/ g_object_class_install_property - (object_class, PROP_READ_ONLY, - g_param_spec_boolean (NM_SETTING_CONNECTION_READ_ONLY, - "Read-Only", - "If TRUE, the connection is read-only and cannot be " - "changed by the user or any other mechanism. This is " - "normally set for system connections whose plugin " - "cannot yet write updated connections back out.", - FALSE, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_FUZZY_IGNORE)); + (object_class, PROP_READ_ONLY, + g_param_spec_boolean (NM_SETTING_CONNECTION_READ_ONLY, "", "", + FALSE, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_FUZZY_IGNORE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingConnection:zone: * - * The trust level of a the connection. - * Free form case-insensitive string (for example "Home", "Work", "Public"). - * NULL or unspecified zone means the connection will be placed in the - * default zone as defined by the firewall. + * The trust level of a the connection. Free form case-insensitive string + * (for example "Home", "Work", "Public"). %NULL or unspecified zone means + * the connection will be placed in the default zone as defined by the + * firewall. **/ g_object_class_install_property (object_class, PROP_ZONE, - g_param_spec_string (NM_SETTING_CONNECTION_ZONE, - "Zone", - "The trust level of a the connection." - "Free form case-insensitive string (for example " - "\"Home\", \"Work\", \"Public\"). NULL or " - "unspecified zone means the connection will be " - "placed in the default zone as defined by the " - "firewall.", - NULL, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_FUZZY_IGNORE)); + g_param_spec_string (NM_SETTING_CONNECTION_ZONE, "", "", + NULL, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_FUZZY_IGNORE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingConnection:master: @@ -1323,46 +1260,40 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class) **/ g_object_class_install_property (object_class, PROP_MASTER, - g_param_spec_string (NM_SETTING_CONNECTION_MASTER, - "Master", - "Interface name of the master device or UUID of " - "the master connection", + g_param_spec_string (NM_SETTING_CONNECTION_MASTER, "", "", NULL, - G_PARAM_READWRITE | NM_SETTING_PARAM_FUZZY_IGNORE | NM_SETTING_PARAM_INFERRABLE)); + G_PARAM_READWRITE | NM_SETTING_PARAM_FUZZY_IGNORE | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingConnection:slave-type: * - * Setting name describing the type of slave device (ie - * #NM_SETTING_BOND_SETTING_NAME) or NULL if this connection is not a slave. + * Setting name of the device type of this slave's master connection (eg, + * %NM_SETTING_BOND_SETTING_NAME), or %NULL if this connection is not a + * slave. **/ g_object_class_install_property (object_class, PROP_SLAVE_TYPE, - g_param_spec_string (NM_SETTING_CONNECTION_SLAVE_TYPE, - "Slave-Type", - "Setting name describing the type of slave " - "this connection is (ie, 'bond') or NULL if this " - "connection is not a slave.", + g_param_spec_string (NM_SETTING_CONNECTION_SLAVE_TYPE, "", "", NULL, - G_PARAM_READWRITE | NM_SETTING_PARAM_FUZZY_IGNORE | NM_SETTING_PARAM_INFERRABLE)); + G_PARAM_READWRITE | NM_SETTING_PARAM_FUZZY_IGNORE | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingConnection:secondaries: * - * List of connection UUIDs that should be activated when the base connection - * itself is activated. Currently only VPN connections are supported. + * List of connection UUIDs that should be activated when the base + * connection itself is activated. Currently only VPN connections are + * supported. * * Since: 0.9.8 **/ g_object_class_install_property (object_class, PROP_SECONDARIES, - _nm_param_spec_specialized (NM_SETTING_CONNECTION_SECONDARIES, - "Secondaries", - "List of connection UUIDs that should be activated " - "when the base connection itself is activated. " - "Currently only VPN connections are supported.", + _nm_param_spec_specialized (NM_SETTING_CONNECTION_SECONDARIES, "", "", DBUS_TYPE_G_LIST_OF_STRING, - G_PARAM_READWRITE | NM_SETTING_PARAM_FUZZY_IGNORE)); + G_PARAM_READWRITE | NM_SETTING_PARAM_FUZZY_IGNORE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingConnection:gateway-ping-timeout: @@ -1374,11 +1305,8 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class) **/ g_object_class_install_property (object_class, PROP_GATEWAY_PING_TIMEOUT, - g_param_spec_uint (NM_SETTING_CONNECTION_GATEWAY_PING_TIMEOUT, - "Gateway Ping Timeout", - "If greater than zero, delay success of IP " - "addressing until either the timeout is reached, or " - "an IP gateway replies to a ping.", + g_param_spec_uint (NM_SETTING_CONNECTION_GATEWAY_PING_TIMEOUT, "", "", 0, 30, 0, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); } diff --git a/libnm-util/nm-setting-dcb.c b/libnm-util/nm-setting-dcb.c index 6723f58d60..f9c9d39f13 100644 --- a/libnm-util/nm-setting-dcb.c +++ b/libnm-util/nm-setting-dcb.c @@ -961,297 +961,246 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class) /** * NMSettingDcb:app-fcoe-flags: * - * Specifies the %NMSettingDcbFlags for the DCB FCoE application. + * Specifies the #NMSettingDcbFlags for the DCB FCoE application. Flags may + * be any combination of %NM_SETTING_DCB_FLAG_ENABLE, + * %NM_SETTING_DCB_FLAG_ADVERTISE, and %NM_SETTING_DCB_FLAG_WILLING. * * Since: 0.9.10 **/ g_object_class_install_property (object_class, PROP_APP_FCOE_FLAGS, - g_param_spec_uint (NM_SETTING_DCB_APP_FCOE_FLAGS, - "App FCoE Flags", - "Specifies the flags for the DCB FCoE application. " - "Flags may be any combination of 0x1 (enable), 0x2 " - "(advertise), and 0x4 (willing).", + g_param_spec_uint (NM_SETTING_DCB_APP_FCOE_FLAGS, "", "", 0, DCB_FLAGS_ALL, 0, - G_PARAM_READWRITE)); + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingDcb:app-fcoe-priority: * * The highest User Priority (0 - 7) which FCoE frames should use, or -1 for - * default priority. Only used when #NMSettingDcb:app-fcoe-flags includes - * %NM_SETTING_DCB_FLAG_ENABLE. + * default priority. Only used when the #NMSettingDcb:app-fcoe-flags + * property includes the %NM_SETTING_DCB_FLAG_ENABLE flag. * * Since: 0.9.10 **/ g_object_class_install_property (object_class, PROP_APP_FCOE_PRIORITY, - g_param_spec_int (NM_SETTING_DCB_APP_FCOE_PRIORITY, - "App FCoE Priority", - "The highest User Priority (0 - 7) which FCoE " - "frames should use, or -1 for default priority. Only " - "used when the 'app-fcoe-flags' property includes " - "the 'enabled' flag.", + g_param_spec_int (NM_SETTING_DCB_APP_FCOE_PRIORITY, "", "", -1, 7, -1, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); /** * NMSettingDcb:app-fcoe-mode: * - * The FCoE controller mode; either %NM_SETTING_DCB_FCOE_MODE_FABRIC (default) - * or %NM_SETTING_DCB_FCOE_MODE_VN2VN. + * The FCoE controller mode; either %NM_SETTING_DCB_FCOE_MODE_FABRIC + * (default) or %NM_SETTING_DCB_FCOE_MODE_VN2VN. * * Since: 0.9.10 **/ g_object_class_install_property (object_class, PROP_APP_FCOE_MODE, - g_param_spec_string (NM_SETTING_DCB_APP_FCOE_MODE, - "App FCoE Mode", - "The FCoe controller mode; either 'fabric' (default) " - "or 'vn2vn'.", + g_param_spec_string (NM_SETTING_DCB_APP_FCOE_MODE, "", "", NM_SETTING_DCB_FCOE_MODE_FABRIC, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); /** * NMSettingDcb:app-iscsi-flags: * - * Specifies the %NMSettingDcbFlags for the DCB iSCSI application. + * Specifies the #NMSettingDcbFlags for the DCB iSCSI application. Flags + * may be any combination of %NM_SETTING_DCB_FLAG_ENABLE, + * %NM_SETTING_DCB_FLAG_ADVERTISE, and %NM_SETTING_DCB_FLAG_WILLING. * * Since: 0.9.10 **/ g_object_class_install_property (object_class, PROP_APP_ISCSI_FLAGS, - g_param_spec_uint (NM_SETTING_DCB_APP_ISCSI_FLAGS, - "App iSCSI Flags", - "Specifies the flags for the DCB iSCSI application. " - "Flags may be any combination of 0x1 (enable), 0x2 " - "(advertise), and 0x4 (willing).", + g_param_spec_uint (NM_SETTING_DCB_APP_ISCSI_FLAGS, "", "", 0, DCB_FLAGS_ALL, 0, - G_PARAM_READWRITE)); + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingDcb:app-iscsi-priority: * - * The highest User Priority (0 - 7) which iSCSI frames should use. Only - * used when #NMSettingDcb:app-iscsi-flags includes %NM_SETTING_DCB_FLAG_ENABLE. + * The highest User Priority (0 - 7) which iSCSI frames should use, or -1 + * for default priority. Only used when the #NMSettingDcb:app-iscsi-flags + * property includes the %NM_SETTING_DCB_FLAG_ENABLE flag. * * Since: 0.9.10 **/ g_object_class_install_property (object_class, PROP_APP_ISCSI_PRIORITY, - g_param_spec_int (NM_SETTING_DCB_APP_ISCSI_PRIORITY, - "App iSCSI Priority", - "The highest User Priority (0 - 7) which iSCSI " - "frames should use, or -1 for default priority. Only " - "used when the 'app-iscsi-flags' property includes " - "the 'enabled' flag.", + g_param_spec_int (NM_SETTING_DCB_APP_ISCSI_PRIORITY, "", "", -1, 7, -1, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); /** * NMSettingDcb:app-fip-flags: * - * Specifies the %NMSettingDcbFlags for the DCB FIP application. + * Specifies the #NMSettingDcbFlags for the DCB FIP application. Flags may + * be any combination of %NM_SETTING_DCB_FLAG_ENABLE, + * %NM_SETTING_DCB_FLAG_ADVERTISE, and %NM_SETTING_DCB_FLAG_WILLING. * * Since: 0.9.10 **/ g_object_class_install_property (object_class, PROP_APP_FIP_FLAGS, - g_param_spec_uint (NM_SETTING_DCB_APP_FIP_FLAGS, - "App FIP Flags", - "Specifies the flags for the DCB FIP application. " - "Flags may be any combination of 0x1 (enable), 0x2 " - "(advertise), and 0x4 (willing).", + g_param_spec_uint (NM_SETTING_DCB_APP_FIP_FLAGS, "", "", 0, DCB_FLAGS_ALL, 0, - G_PARAM_READWRITE)); + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingDcb:app-fip-priority: * - * The highest User Priority (0 - 7) which FIP frames should use. Only - * used when #NMSettingDcb:app-fip-flags includes %NM_SETTING_DCB_FLAG_ENABLE. + * The highest User Priority (0 - 7) which FIP frames should use, or -1 for + * default priority. Only used when the #NMSettingDcb:app-fip-flags + * property includes the %NM_SETTING_DCB_FLAG_ENABLE flag. * * Since: 0.9.10 **/ g_object_class_install_property (object_class, PROP_APP_FIP_PRIORITY, - g_param_spec_int (NM_SETTING_DCB_APP_FIP_PRIORITY, - "App FIP Priority", - "The highest User Priority (0 - 7) which FIP " - "frames should use, or -1 for default priority. Only " - "used when the 'app-fip-flags' property includes " - "the 'enabled' flag.", + g_param_spec_int (NM_SETTING_DCB_APP_FIP_PRIORITY, "", "", -1, 7, -1, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); /** * NMSettingDcb:priority-flow-control-flags: * - * Specifies the %NMSettingDcbFlags for DCB Priority Flow Control (PFC). + * Specifies the #NMSettingDcbFlags for DCB Priority Flow Control (PFC). + * Flags may be any combination of %NM_SETTING_DCB_FLAG_ENABLE, + * %NM_SETTING_DCB_FLAG_ADVERTISE, and %NM_SETTING_DCB_FLAG_WILLING. * * Since: 0.9.10 **/ g_object_class_install_property (object_class, PROP_PFC_FLAGS, - g_param_spec_uint (NM_SETTING_DCB_PRIORITY_FLOW_CONTROL_FLAGS, - "Priority Flow Control Flags", - "Specifies the flags for DCB Priority Flow Control. " - "Flags may be any combination of 0x1 (enable), 0x2 " - "(advertise), and 0x4 (willing).", + g_param_spec_uint (NM_SETTING_DCB_PRIORITY_FLOW_CONTROL_FLAGS, "", "", 0, DCB_FLAGS_ALL, 0, - G_PARAM_READWRITE)); + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingDcb:priority-flow-control: * - * An array of 8 uint values, where the array index corresponds to the - * User Priority (0 - 7) and the value indicates whether or not the - * corresponding priority should transmit priority pause. Allowed values - * are 0 (do not transmit pause) and 1 (transmit pause). + * An array of 8 uint values, where the array index corresponds to the User + * Priority (0 - 7) and the value indicates whether or not the corresponding + * priority should transmit priority pause. Allowed values are 0 (do not + * transmit pause) and 1 (transmit pause). * * Since: 0.9.10 **/ g_object_class_install_property (object_class, PROP_PFC, - _nm_param_spec_specialized (NM_SETTING_DCB_PRIORITY_FLOW_CONTROL, - "Priority Flow Control", - "An array of 8 uint values, where the array index " - "corresponds to the User Priority (0 - 7) and the " - "value indicates whether or not the corresponding " - "priority should transmit priority pause. Allowed " - "values are 0 (do not transmit pause) and 1 " - "(transmit pause).", + _nm_param_spec_specialized (NM_SETTING_DCB_PRIORITY_FLOW_CONTROL, "", "", DBUS_TYPE_G_UINT_ARRAY, - G_PARAM_READWRITE)); + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingDcb:priority-group-flags: * - * Specifies the %NMSettingDcbFlags for DCB Priority Groups. + * Specifies the #NMSettingDcbFlags for DCB Priority Groups. Flags may be + * any combination of %NM_SETTING_DCB_FLAG_ENABLE, + * %NM_SETTING_DCB_FLAG_ADVERTISE, and %NM_SETTING_DCB_FLAG_WILLING. * * Since: 0.9.10 **/ g_object_class_install_property (object_class, PROP_PRIORITY_GROUP_FLAGS, - g_param_spec_uint (NM_SETTING_DCB_PRIORITY_GROUP_FLAGS, - "Priority Group Flags", - "Specifies the flags for DCB Priority Groups. " - "Flags may be any combination of 0x1 (enable), 0x2 " - "(advertise), and 0x4 (willing).", + g_param_spec_uint (NM_SETTING_DCB_PRIORITY_GROUP_FLAGS, "", "", 0, DCB_FLAGS_ALL, 0, - G_PARAM_READWRITE)); + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingDcb:priority-group-id: * - * An array of 8 uint values, where the array index corresponds to the - * User Priority (0 - 7) and the value indicates the Priority Group ID. - * Allowed Priority Group ID values are 0 - 7 or 15 for the unrestricted - * group. + * An array of 8 uint values, where the array index corresponds to the User + * Priority (0 - 7) and the value indicates the Priority Group ID. Allowed + * Priority Group ID values are 0 - 7 or 15 for the unrestricted group. * * Since: 0.9.10 **/ g_object_class_install_property (object_class, PROP_PRIORITY_GROUP_ID, - _nm_param_spec_specialized (NM_SETTING_DCB_PRIORITY_GROUP_ID, - "Priority Group ID", - "An array of 8 uint values, where the array " - "index corresponds to the User Priority (0 - 7) " - "and the value indicates the Priority Group ID. " - "Allowed Priority Group ID values are 0 - 7 or " - "15 for the unrestricted group.", + _nm_param_spec_specialized (NM_SETTING_DCB_PRIORITY_GROUP_ID, "", "", DBUS_TYPE_G_UINT_ARRAY, - G_PARAM_READWRITE)); + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingDcb:priority-group-bandwidth: * * An array of 8 uint values, where the array index corresponds to the - * Priority Group ID (0 - 7) and the value indicates the percentage of - * link bandwidth allocated to that group. Allowed values are 0 - 100, - * and the sum of all values must total 100 percent. + * Priority Group ID (0 - 7) and the value indicates the percentage of link + * bandwidth allocated to that group. Allowed values are 0 - 100, and the + * sum of all values must total 100 percent. * * Since: 0.9.10 **/ g_object_class_install_property (object_class, PROP_PRIORITY_GROUP_BANDWIDTH, - _nm_param_spec_specialized (NM_SETTING_DCB_PRIORITY_GROUP_BANDWIDTH, - "Priority Group Bandwidth", - "An array of 8 uint values, where the array index " - "corresponds to the Priority Group ID (0 - 7) and " - "the value indicates the percentage of link bandwidth " - "allocated to that group. Allowed values are 0 - 100, " - "and the sum of all values must total 100 percent.", + _nm_param_spec_specialized (NM_SETTING_DCB_PRIORITY_GROUP_BANDWIDTH, "", "", DBUS_TYPE_G_UINT_ARRAY, - G_PARAM_READWRITE)); + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingDcb:priority-bandwidth: * - * An array of 8 uint values, where the array index corresponds to the - * User Priority (0 - 7) and the value indicates the percentage of bandwidth - * of the priority's assigned group that the priority may use. The sum of - * all percentages for priorities which belong to the same group must total - * 100 percent. + * An array of 8 uint values, where the array index corresponds to the User + * Priority (0 - 7) and the value indicates the percentage of bandwidth of + * the priority's assigned group that the priority may use. The sum of all + * percentages for priorities which belong to the same group must total 100 + * percent. * * Since: 0.9.10 **/ g_object_class_install_property (object_class, PROP_PRIORITY_BANDWIDTH, - _nm_param_spec_specialized (NM_SETTING_DCB_PRIORITY_BANDWIDTH, - "Priority Bandwidth", - "An array of 8 uint values, where the array index " - "corresponds to the User Priority (0 - 7) and the " - "value indicates the percentage of bandwidth of " - "the priority's assigned group that the priority may " - "use. The sum of all percentages for priorities which " - "belong to the same group must total 100 percent.", + _nm_param_spec_specialized (NM_SETTING_DCB_PRIORITY_BANDWIDTH, "", "", DBUS_TYPE_G_UINT_ARRAY, - G_PARAM_READWRITE)); + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** - * NMSettingDcb:priority-strict: + * NMSettingDcb:priority-strict-bandwidth: * - * An array of 8 uint values, where the array index corresponds to the - * User Priority (0 - 7) and the value indicates whether or not the - * priority may use all of the bandwidth allocated to its assigned group. - * Allowed values are 0 (the priority may not utilize all bandwidth) or - * 1 (the priority may utilize all bandwidth). + * An array of 8 uint values, where the array index corresponds to the User + * Priority (0 - 7) and the value indicates whether or not the priority may + * use all of the bandwidth allocated to its assigned group. Allowed values + * are 0 (the priority may not utilize all bandwidth) or 1 (the priority may + * utilize all bandwidth). * * Since: 0.9.10 **/ g_object_class_install_property (object_class, PROP_PRIORITY_STRICT, - _nm_param_spec_specialized (NM_SETTING_DCB_PRIORITY_STRICT_BANDWIDTH, - "Priority Strict", - "An array of 8 uint values, where the array index " - "corresponds to the User Priority (0 - 7) and the " - "value indicates whether or not the priority may " - "use all of the bandwidth allocated to its assigned " - "group. Allowed values are 0 (the priority may not " - "utilize all bandwidth) or 1 (the priority may " - "utilize all bandwidth).", + _nm_param_spec_specialized (NM_SETTING_DCB_PRIORITY_STRICT_BANDWIDTH, "", "", DBUS_TYPE_G_UINT_ARRAY, - G_PARAM_READWRITE)); + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingDcb:priority-traffic-class: * - * An array of 8 uint values, where the array index corresponds to the - * User Priority (0 - 7) and the value indicates the traffic class (0 - 7) - * to which the priority is mapped. + * An array of 8 uint values, where the array index corresponds to the User + * Priority (0 - 7) and the value indicates the traffic class (0 - 7) to + * which the priority is mapped. * * Since: 0.9.10 **/ g_object_class_install_property (object_class, PROP_PRIORITY_TRAFFIC_CLASS, - _nm_param_spec_specialized (NM_SETTING_DCB_PRIORITY_TRAFFIC_CLASS, - "Priority Traffic Class", - "An array of 8 uint values, where the array index " - "corresponds to the User Priority (0 - 7) and the " - "value indicates the traffic class (0 - 7) to which " - "the priority is mapped.", + _nm_param_spec_specialized (NM_SETTING_DCB_PRIORITY_TRAFFIC_CLASS, "", "", DBUS_TYPE_G_UINT_ARRAY, - G_PARAM_READWRITE)); + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); } diff --git a/libnm-util/nm-setting-gsm.c b/libnm-util/nm-setting-gsm.c index 4e0f28dfdc..3b814cd7c1 100644 --- a/libnm-util/nm-setting-gsm.c +++ b/libnm-util/nm-setting-gsm.c @@ -554,16 +554,10 @@ nm_setting_gsm_class_init (NMSettingGsmClass *setting_class) **/ g_object_class_install_property (object_class, PROP_NUMBER, - g_param_spec_string (NM_SETTING_GSM_NUMBER, - "Number", - "Number to dial when establishing a PPP data session " - "with the GSM-based mobile broadband network. Many " - "modems do not require PPP for connections to the " - "mobile network and thus this property should be left " - "blank, which allows NetworkManager to select the " - "appropriate settings automatically.", - NULL, - G_PARAM_READWRITE)); + g_param_spec_string (NM_SETTING_GSM_NUMBER, "", "", + NULL, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingGsm:username: @@ -574,13 +568,10 @@ nm_setting_gsm_class_init (NMSettingGsmClass *setting_class) **/ g_object_class_install_property (object_class, PROP_USERNAME, - g_param_spec_string (NM_SETTING_GSM_USERNAME, - "Username", - "Username used to authenticate with the network, if " - "required. Note that many providers do not require " - "a username or accept any username.", - NULL, - G_PARAM_READWRITE)); + g_param_spec_string (NM_SETTING_GSM_USERNAME, "", "", + NULL, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingGsm:password: @@ -591,27 +582,24 @@ nm_setting_gsm_class_init (NMSettingGsmClass *setting_class) **/ g_object_class_install_property (object_class, PROP_PASSWORD, - g_param_spec_string (NM_SETTING_GSM_PASSWORD, - "Password", - "Password used to authenticate with the network, if " - "required. Note that many providers do not require " - "a password or accept any password.", - NULL, - G_PARAM_READWRITE | NM_SETTING_PARAM_SECRET)); + g_param_spec_string (NM_SETTING_GSM_PASSWORD, "", "", + NULL, + G_PARAM_READWRITE | NM_SETTING_PARAM_SECRET | + G_PARAM_STATIC_STRINGS)); /** * NMSettingGsm:password-flags: * - * Flags indicating how to handle #NMSettingGsm:password:. + * Flags indicating how to handle the #NMSettingGsm:password property. **/ - g_object_class_install_property (object_class, PROP_PASSWORD_FLAGS, - g_param_spec_uint (NM_SETTING_GSM_PASSWORD_FLAGS, - "Password Flags", - "Flags indicating how to handle the GSM password.", + g_object_class_install_property + (object_class, PROP_PASSWORD_FLAGS, + g_param_spec_uint (NM_SETTING_GSM_PASSWORD_FLAGS, "", "", NM_SETTING_SECRET_FLAG_NONE, NM_SETTING_SECRET_FLAGS_ALL, NM_SETTING_SECRET_FLAG_NONE, - G_PARAM_READWRITE)); + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingGsm:apn: @@ -621,24 +609,15 @@ nm_setting_gsm_class_init (NMSettingGsmClass *setting_class) * the user will be billed for their network usage and whether the user has * access to the Internet or just a provider-specific walled-garden, so it * is important to use the correct APN for the user's mobile broadband plan. - * The APN may only be composed of the characters a-z, 0-9, ., and - per - * GSM 03.60 Section 14.9. + * The APN may only be composed of the characters a-z, 0-9, ., and - per GSM + * 03.60 Section 14.9. **/ g_object_class_install_property (object_class, PROP_APN, - g_param_spec_string (NM_SETTING_GSM_APN, - "APN", - "The GPRS Access Point Name specifying the APN used " - "when establishing a data session with the GSM-based " - "network. The APN often determines how the user will " - "be billed for their network usage and whether the " - "user has access to the Internet or just a provider-" - "specific walled-garden, so it is important to use " - "the correct APN for the user's mobile broadband " - "plan. The APN may only be composed of the characters " - "a-z, 0-9, ., and - per GSM 03.60 Section 14.9.", - NULL, - G_PARAM_READWRITE)); + g_param_spec_string (NM_SETTING_GSM_APN, "", "", + NULL, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingGsm:network-id: @@ -651,43 +630,35 @@ nm_setting_gsm_class_init (NMSettingGsmClass *setting_class) **/ g_object_class_install_property (object_class, PROP_NETWORK_ID, - g_param_spec_string (NM_SETTING_GSM_NETWORK_ID, - "Network ID", - "The Network ID (GSM LAI format, ie MCC-MNC) to force " - "specific network registration. If the Network ID is " - "specified, NetworkManager will attempt to force the " - "device to register only on the specified network. " - "This can be used to ensure that the device does not " - "roam when direct roaming control of the device is " - "not otherwise possible.", - NULL, - G_PARAM_READWRITE)); + g_param_spec_string (NM_SETTING_GSM_NETWORK_ID, "", "", + NULL, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingGsm:network-type: * * Network preference to force the device to only use specific network - * technologies. Permitted values are those specified by - * #NMSettingGsmNetworkType. Note that not all devices allow network + * technologies. The permitted values are %NM_SETTING_GSM_NETWORK_TYPE_ANY, + * %NM_SETTING_GSM_NETWORK_TYPE_UMTS_HSPA, + * %NM_SETTING_GSM_NETWORK_TYPE_GPRS_EDGE, + * %NM_SETTING_GSM_NETWORK_TYPE_PREFER_UMTS_HSPA, + * %NM_SETTING_GSM_NETWORK_TYPE_PREFER_GPRS_EDGE, + * %NM_SETTING_GSM_NETWORK_TYPE_PREFER_4G, and + * %NM_SETTING_GSM_NETWORK_TYPE_4G. Note that not all devices allow network * preference control. * - * Deprecated: 0.9.10: No longer used. Network type setting should be done talking to ModemManager directly. + * Deprecated: 0.9.10: No longer used. Network type setting should be done + * by talking to ModemManager directly. **/ g_object_class_install_property (object_class, PROP_NETWORK_TYPE, - g_param_spec_int (NM_SETTING_GSM_NETWORK_TYPE, - "Network type", - "Network preference to force the device to only use " - "specific network technologies. The permitted values " - "are: -1: any, 0: 3G only, 1: GPRS/EDGE only, " - "2: prefer 3G, 3: prefer 2G, 4: prefer 4G/LTE, 5: 4G/LTE only. " - "Notes: This property is deprecated and NetworkManager from 0.9.10 " - "onwards doesn't use this property when talking to ModemManager." - "Also, not all devices allow network preference control.", + g_param_spec_int (NM_SETTING_GSM_NETWORK_TYPE, "", "", NM_SETTING_GSM_NETWORK_TYPE_ANY, NM_SETTING_GSM_NETWORK_TYPE_4G, NM_SETTING_GSM_NETWORK_TYPE_ANY, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); /** * NMSettingGsm:allowed-bands: @@ -696,65 +667,56 @@ nm_setting_gsm_class_init (NMSettingGsmClass *setting_class) * frequency band control. Permitted values are those specified by * #NMSettingGsmNetworkBand. * - * Deprecated: 0.9.10: No longer used. Band setting should be done talking to ModemManager directly. + * Deprecated: 0.9.10: No longer used. Band setting should be done by + * talking to ModemManager directly. **/ g_object_class_install_property (object_class, PROP_ALLOWED_BANDS, - g_param_spec_uint (NM_SETTING_GSM_ALLOWED_BANDS, - "Allowed Bands", - "Bitfield of allowed frequency bands." - "Notes: This property is deprecated and NetworkManager from 0.9.10 " - "onwards doesn't use this property when talking to ModemManager." - "Also, not all devices allow frequency band control.", + g_param_spec_uint (NM_SETTING_GSM_ALLOWED_BANDS, "", "", NM_SETTING_GSM_BAND_UNKNOWN, NM_SETTING_GSM_BANDS_MAX, NM_SETTING_GSM_BAND_ANY, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); /** * NMSettingGsm:pin: * * If the SIM is locked with a PIN it must be unlocked before any other - * operations are requested. Specify the PIN here to allow operation of - * the device. + * operations are requested. Specify the PIN here to allow operation of the + * device. **/ g_object_class_install_property (object_class, PROP_PIN, - g_param_spec_string (NM_SETTING_GSM_PIN, - "PIN", - "If the SIM is locked with a PIN it must be unlocked " - "before any other operations are requested. Specify " - "the PIN here to allow operation of the device.", - NULL, - G_PARAM_READWRITE | NM_SETTING_PARAM_SECRET)); + g_param_spec_string (NM_SETTING_GSM_PIN, "", "", + NULL, + G_PARAM_READWRITE | NM_SETTING_PARAM_SECRET | + G_PARAM_STATIC_STRINGS)); /** * NMSettingGsm:pin-flags: * - * Flags indicating how to handle #NMSettingGsm:pin. + * Flags indicating how to handle the #NMSettingGsm:pin property. **/ - g_object_class_install_property (object_class, PROP_PIN_FLAGS, - g_param_spec_uint (NM_SETTING_GSM_PIN_FLAGS, - "PIN Flags", - "Flags indicating how to handle the GSM SIM PIN.", + g_object_class_install_property + (object_class, PROP_PIN_FLAGS, + g_param_spec_uint (NM_SETTING_GSM_PIN_FLAGS, "", "", NM_SETTING_SECRET_FLAG_NONE, NM_SETTING_SECRET_FLAGS_ALL, NM_SETTING_SECRET_FLAG_NONE, - G_PARAM_READWRITE)); + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingGsm:home-only: * - * When TRUE, only connections to the home network will be allowed. + * When %TRUE, only connections to the home network will be allowed. * Connections to roaming networks will not be made. **/ g_object_class_install_property (object_class, PROP_HOME_ONLY, - g_param_spec_boolean (NM_SETTING_GSM_HOME_ONLY, - "Home Only", - "When TRUE, only connections to the home network will " - "be allowed. Connections to roaming networks will " - "not be made.", - FALSE, - G_PARAM_READWRITE)); + g_param_spec_boolean (NM_SETTING_GSM_HOME_ONLY, "", "", + FALSE, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); } diff --git a/libnm-util/nm-setting-infiniband.c b/libnm-util/nm-setting-infiniband.c index 62ed53f13a..2552cd9c46 100644 --- a/libnm-util/nm-setting-infiniband.c +++ b/libnm-util/nm-setting-infiniband.c @@ -353,20 +353,16 @@ nm_setting_infiniband_class_init (NMSettingInfinibandClass *setting_class) /** * NMSettingInfiniband:mac-address: * - * If specified, this connection will only apply to the IPoIB - * device whose permanent MAC address matches. This property does - * not change the MAC address of the device (i.e. MAC spoofing). + * If specified, this connection will only apply to the IPoIB device whose + * permanent MAC address matches. This property does not change the MAC + * address of the device (i.e. MAC spoofing). **/ g_object_class_install_property (object_class, PROP_MAC_ADDRESS, - _nm_param_spec_specialized (NM_SETTING_INFINIBAND_MAC_ADDRESS, - "Device MAC Address", - "If specified, this connection will only apply to " - "the IPoIB device whose permanent MAC address matches. " - "This property does not change the MAC address " - "of the device (i.e. MAC spoofing).", + _nm_param_spec_specialized (NM_SETTING_INFINIBAND_MAC_ADDRESS, "", "", DBUS_TYPE_G_UCHAR_ARRAY, - G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE)); + G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingInfiniband:mtu: @@ -376,59 +372,52 @@ nm_setting_infiniband_class_init (NMSettingInfinibandClass *setting_class) **/ g_object_class_install_property (object_class, PROP_MTU, - g_param_spec_uint (NM_SETTING_INFINIBAND_MTU, - "MTU", - "If non-zero, only transmit packets of the specified " - "size or smaller, breaking larger packets up into " - "multiple frames.", + g_param_spec_uint (NM_SETTING_INFINIBAND_MTU, "", "", 0, G_MAXUINT32, 0, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_FUZZY_IGNORE)); + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_FUZZY_IGNORE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingInfiniband:transport-mode: * - * The IP-over-InfiniBand transport mode. Either 'datagram' or - * 'connected'. + * The IP-over-InfiniBand transport mode. Either "datagram" or + * "connected". **/ g_object_class_install_property (object_class, PROP_TRANSPORT_MODE, - g_param_spec_string (NM_SETTING_INFINIBAND_TRANSPORT_MODE, - "Transport Mode", - "The IPoIB transport mode. Either 'datagram' or 'connected'.", + g_param_spec_string (NM_SETTING_INFINIBAND_TRANSPORT_MODE, "", "", NULL, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_INFERRABLE)); + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingInfiniband:p-key: * - * The InfiniBand P_Key to use for this device. A value of -1 - * means to use the default P_Key (aka "the P_Key at index 0"). - * Otherwise it is a 16-bit unsigned integer, whose high bit - * is set if it is a "full membership" P_Key. + * The InfiniBand P_Key to use for this device. A value of -1 means to use + * the default P_Key (aka "the P_Key at index 0"). Otherwise it is a 16-bit + * unsigned integer, whose high bit is set if it is a "full membership" + * P_Key. **/ g_object_class_install_property (object_class, PROP_P_KEY, - g_param_spec_int (NM_SETTING_INFINIBAND_P_KEY, - "P_Key", - "The InfiniBand P_Key. Either -1 for the " - "default, or a 16-bit unsigned integer.", + g_param_spec_int (NM_SETTING_INFINIBAND_P_KEY, "", "", -1, 0xFFFF, -1, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_INFERRABLE)); + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingInfiniband:parent: * - * The interface name of the parent device of this device. Normally - * %NULL, but if #NMSettingInfiniband:p_key is set, then you must + * The interface name of the parent device of this device. Normally %NULL, + * but if the #NMSettingInfiniband:p_key property is set, then you must * specify the base device by setting either this property or * #NMSettingInfiniband:mac-address. **/ g_object_class_install_property (object_class, PROP_PARENT, - g_param_spec_string (NM_SETTING_INFINIBAND_PARENT, - "Parent", - "The interface name of the parent device, or NULL", + g_param_spec_string (NM_SETTING_INFINIBAND_PARENT, "", "", NULL, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_INFERRABLE)); + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); } diff --git a/libnm-util/nm-setting-ip4-config.c b/libnm-util/nm-setting-ip4-config.c index 9dc7fd95bc..81bd481688 100644 --- a/libnm-util/nm-setting-ip4-config.c +++ b/libnm-util/nm-setting-ip4-config.c @@ -1221,91 +1221,58 @@ nm_setting_ip4_config_class_init (NMSettingIP4ConfigClass *setting_class) /** * NMSettingIP4Config:method: * - * IPv4 configuration method. If 'auto' is specified then the appropriate + * IPv4 configuration method. If "auto" is specified then the appropriate * automatic method (DHCP, PPP, etc) is used for the interface and most - * other properties can be left unset. If 'link-local' is specified, then a + * other properties can be left unset. If "link-local" is specified, then a * link-local address in the 169.254/16 range will be assigned to the - * interface. If 'manual' is specified, static IP addressing is used and at - * least one IP address must be given in the 'addresses' property. If - * 'shared' is specified (indicating that this connection will provide + * interface. If "manual" is specified, static IP addressing is used and at + * least one IP address must be given in the "addresses" property. If + * "shared" is specified (indicating that this connection will provide * network access to other computers) then the interface is assigned an * address in the 10.42.x.1/24 range and a DHCP and forwarding DNS server * are started, and the interface is NAT-ed to the current default network - * connection. 'disabled' means IPv4 will not be used on this connection. + * connection. "disabled" means IPv4 will not be used on this connection. * This property must be set. **/ g_object_class_install_property (object_class, PROP_METHOD, - g_param_spec_string (NM_SETTING_IP4_CONFIG_METHOD, - "Method", - "IPv4 configuration method. If 'auto' is specified " - "then the appropriate automatic method (DHCP, PPP, " - "etc) is used for the interface and most other " - "properties can be left unset. If 'link-local' " - "is specified, then a link-local address in the " - "169.254/16 range will be assigned to the " - "interface. If 'manual' is specified, static IP " - "addressing is used and at least one IP address " - "must be given in the 'addresses' property. If " - "'shared' is specified (indicating that this " - "connection will provide network access to other " - "computers) then the interface is assigned an " - "address in the 10.42.x.1/24 range and a DHCP and " - "forwarding DNS server are started, and the " - "interface is NAT-ed to the current default network " - "connection. 'disabled' means IPv4 will not be " - "used on this connection. This property must be set.", - NULL, - G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE)); + g_param_spec_string (NM_SETTING_IP4_CONFIG_METHOD, "", "", + NULL, + G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingIP4Config:dns: * - * List of DNS servers (network byte order). For the 'auto' method, these + * List of DNS servers (network byte order). For the "auto" method, these * DNS servers are appended to those (if any) returned by automatic - * configuration. DNS servers cannot be used with the 'shared', 'link-local', - * or 'disabled' methods as there is no upstream network. In all other - * methods, these DNS servers are used as the only DNS servers for this - * connection. + * configuration. DNS servers cannot be used with the "shared", + * "link-local", or "disabled" methods as there is no upstream network. In + * all other methods, these DNS servers are used as the only DNS servers for + * this connection. **/ g_object_class_install_property (object_class, PROP_DNS, - _nm_param_spec_specialized (NM_SETTING_IP4_CONFIG_DNS, - "DNS", - "List of DNS servers (network byte order). For " - "the 'auto' method, these DNS servers are " - "appended to those (if any) returned by automatic " - "configuration. DNS servers cannot be used with " - "the 'shared', 'link-local', or 'disabled' " - "methods as there is no upstream network. In all " - "other methods, these DNS servers are used as the " - "only DNS servers for this connection.", - DBUS_TYPE_G_UINT_ARRAY, - G_PARAM_READWRITE)); + _nm_param_spec_specialized (NM_SETTING_IP4_CONFIG_DNS, "", "", + DBUS_TYPE_G_UINT_ARRAY, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingIP4Config:dns-search: * - * List of DNS search domains. For the 'auto' method, these search domains + * List of DNS search domains. For the "auto" method, these search domains * are appended to those returned by automatic configuration. Search domains - * cannot be used with the 'shared', 'link-local', or 'disabled' methods as + * cannot be used with the "shared", "link-local", or "disabled" methods as * there is no upstream network. In all other methods, these search domains * are used as the only search domains for this connection. **/ g_object_class_install_property (object_class, PROP_DNS_SEARCH, - _nm_param_spec_specialized (NM_SETTING_IP4_CONFIG_DNS_SEARCH, - "DNS search", - "List of DNS search domains. For the 'auto' " - "method, these search domains are appended to " - "those returned by automatic configuration. " - "Search domains cannot be used with the 'shared', " - "'link-local', or 'disabled' methods as there is " - "no upstream network. In all other methods, these " - "search domains are used as the only search domains " - "for this connection.", - DBUS_TYPE_G_LIST_OF_STRING, - G_PARAM_READWRITE)); + _nm_param_spec_specialized (NM_SETTING_IP4_CONFIG_DNS_SEARCH, "", "", + DBUS_TYPE_G_LIST_OF_STRING, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingIP4Config:addresses: @@ -1314,106 +1281,73 @@ nm_setting_ip4_config_class_init (NMSettingIP4ConfigClass *setting_class) * composed of 3 32-bit values; the first being the IPv4 address (network * byte order), the second the prefix (1 - 32), and last the IPv4 gateway * (network byte order). The gateway may be left as 0 if no gateway exists - * for that subnet. For the 'auto' method, given IP addresses are appended + * for that subnet. For the "auto" method, given IP addresses are appended * to those returned by automatic configuration. Addresses cannot be used - * with the 'shared', 'link-local', or 'disabled' methods as addressing is + * with the "shared", "link-local", or "disabled" methods as addressing is * either automatic or disabled with these methods. **/ g_object_class_install_property (object_class, PROP_ADDRESSES, - _nm_param_spec_specialized (NM_SETTING_IP4_CONFIG_ADDRESSES, - "Addresses", - "Array of IPv4 address structures. Each IPv4 " - "address structure is composed of 3 32-bit values; " - "the first being the IPv4 address (network byte " - "order), the second the prefix (1 - 32), and " - "last the IPv4 gateway (network byte order). The " - "gateway may be left as 0 if no gateway exists " - "for that subnet. For the 'auto' method, given " - "IP addresses are appended to those returned by " - "automatic configuration. Addresses cannot be " - "used with the 'shared', 'link-local', or " - "'disabled' methods as addressing is either " - "automatic or disabled with these methods.", - DBUS_TYPE_G_ARRAY_OF_ARRAY_OF_UINT, - G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE)); + _nm_param_spec_specialized (NM_SETTING_IP4_CONFIG_ADDRESSES, "", "", + DBUS_TYPE_G_ARRAY_OF_ARRAY_OF_UINT, + G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); g_object_class_install_property (object_class, PROP_ADDRESS_LABELS, - _nm_param_spec_specialized ("address-labels", - "Address labels", - "Internal use only", + _nm_param_spec_specialized ("address-labels", "", "", DBUS_TYPE_G_LIST_OF_STRING, - G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE)); + G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingIP4Config:routes: * - * Array of IPv4 route structures. Each IPv4 route structure is composed - * of 4 32-bit values; the first being the destination IPv4 network or - * address (network byte order), the second the destination network or - * address prefix (1 - 32), the third being the next-hop (network byte - * order) if any, and the fourth being the route metric. For the 'auto' - * method, given IP routes are appended to those returned by automatic - * configuration. Routes cannot be used with the 'shared', 'link-local', - * or 'disabled' methods because there is no upstream network. + * Array of IPv4 route structures. Each IPv4 route structure is composed of + * 4 32-bit values; the first being the destination IPv4 network or address + * (network byte order), the second the destination network or address + * prefix (1 - 32), the third being the next-hop (network byte order) if + * any, and the fourth being the route metric. For the "auto" method, given + * IP routes are appended to those returned by automatic configuration. + * Routes cannot be used with the "shared", "link-local", or "disabled" + * methods because there is no upstream network. **/ g_object_class_install_property (object_class, PROP_ROUTES, - _nm_param_spec_specialized (NM_SETTING_IP4_CONFIG_ROUTES, - "Routes", - "Array of IPv4 route structures. Each IPv4 route " - "structure is composed of 4 32-bit values; the " - "first being the destination IPv4 network or " - "address (network byte order), the second the " - "destination network or address prefix (1 - 32), " - "the third being the next-hop (network byte order) " - "if any, and the fourth being the route metric. " - "For the 'auto' method, given IP routes are " - "appended to those returned by automatic " - "configuration. Routes cannot be used with the " - "'shared', 'link-local', or 'disabled', methods " - "as there is no upstream network.", - DBUS_TYPE_G_ARRAY_OF_ARRAY_OF_UINT, - G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE)); + _nm_param_spec_specialized (NM_SETTING_IP4_CONFIG_ROUTES, "", "", + DBUS_TYPE_G_ARRAY_OF_ARRAY_OF_UINT, + G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingIP4Config:ignore-auto-routes: * - * When the method is set to 'auto' and this property to TRUE, automatically - * configured routes are ignored and only routes specified in - * #NMSettingIP4Config:routes, if any, are used. + * When the method is set to "auto" and this property to %TRUE, + * automatically configured routes are ignored and only routes specified in + * the #NMSettingIP4Config:routes property, if any, are used. **/ g_object_class_install_property (object_class, PROP_IGNORE_AUTO_ROUTES, - g_param_spec_boolean (NM_SETTING_IP4_CONFIG_IGNORE_AUTO_ROUTES, - "Ignore automatic routes", - "When the method is set to 'auto' and this property " - "to TRUE, automatically configured routes are " - "ignored and only routes specified in the 'routes' " - "property, if any, are used.", - FALSE, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + g_param_spec_boolean (NM_SETTING_IP4_CONFIG_IGNORE_AUTO_ROUTES, "", "", + FALSE, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); /** * NMSettingIP4Config:ignore-auto-dns: * - * When the method is set to 'auto' and this property to TRUE, automatically - * configured nameservers and search domains are ignored and only nameservers - * and search domains specified in #NMSettingIP4Config:dns and - * #NMSettingIP4Config:dns-search, if any, are used. + * When the method is set to "auto" and this property to %TRUE, + * automatically configured nameservers and search domains are ignored and + * only nameservers and search domains specified in the + * #NMSettingIP4Config:dns and #NMSettingIP4Config:dns-search properties, if + * any, are used. **/ g_object_class_install_property (object_class, PROP_IGNORE_AUTO_DNS, - g_param_spec_boolean (NM_SETTING_IP4_CONFIG_IGNORE_AUTO_DNS, - "Ignore automatic DNS", - "When the method is set to 'auto' and this property " - "to TRUE, automatically configured nameservers and " - "search domains are ignored and only nameservers and " - "search domains specified in the 'dns' and 'dns-search' " - "properties, if any, are used.", - FALSE, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + g_param_spec_boolean (NM_SETTING_IP4_CONFIG_IGNORE_AUTO_DNS, "", "", + FALSE, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); /** * NMSettingIP4Config:dhcp-client-id: @@ -1423,93 +1357,69 @@ nm_setting_ip4_config_class_init (NMSettingIP4ConfigClass *setting_class) **/ g_object_class_install_property (object_class, PROP_DHCP_CLIENT_ID, - g_param_spec_string (NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID, - "DHCP Client ID", - "A string sent to the DHCP server to identify the " - "local machine which the DHCP server may use to " - "customize the DHCP lease and options.", - NULL, - G_PARAM_READWRITE)); + g_param_spec_string (NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID, "", "", + NULL, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingIP4Config:dhcp-send-hostname: * - * If TRUE, a hostname is sent to the DHCP server when acquiring a lease. + * If %TRUE, a hostname is sent to the DHCP server when acquiring a lease. * Some DHCP servers use this hostname to update DNS databases, essentially - * providing a static hostname for the computer. If - * #NMSettingIP4Config:dhcp-hostname is empty and this property is TRUE, - * the current persistent hostname of the computer is sent. + * providing a static hostname for the computer. If the + * #NMSettingIP4Config:dhcp-hostname property is empty and this property is + * %TRUE, the current persistent hostname of the computer is sent. **/ g_object_class_install_property (object_class, PROP_DHCP_SEND_HOSTNAME, - g_param_spec_boolean (NM_SETTING_IP4_CONFIG_DHCP_SEND_HOSTNAME, - "Send DHCP hostname", - "If TRUE, a hostname is sent to the DHCP server when " - "acquiring a lease. Some DHCP servers use this " - "hostname to update DNS databases, essentially " - "providing a static hostname for the computer. If " - "the 'dhcp-hostname' property is empty and this " - "property is TRUE, the current persistent hostname " - "of the computer is sent.", - TRUE, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + g_param_spec_boolean (NM_SETTING_IP4_CONFIG_DHCP_SEND_HOSTNAME, "", "", + TRUE, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); /** * NMSettingIP4Config:dhcp-hostname: * - * If the #NMSettingIP4Config:dhcp-send-hostname property is TRUE, then the + * If the #NMSettingIP4Config:dhcp-send-hostname property is %TRUE, then the * specified name will be sent to the DHCP server when acquiring a lease. **/ g_object_class_install_property (object_class, PROP_DHCP_HOSTNAME, - g_param_spec_string (NM_SETTING_IP4_CONFIG_DHCP_HOSTNAME, - "DHCP Hostname", - "If the 'dhcp-send-hostname' property is TRUE, then " - "the specified name will be sent to the DHCP server " - "when acquiring a lease.", - NULL, - G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE)); + g_param_spec_string (NM_SETTING_IP4_CONFIG_DHCP_HOSTNAME, "", "", + NULL, + G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingIP4Config:never-default: * - * If TRUE, this connection will never be the default IPv4 connection, + * If %TRUE, this connection will never be the default IPv4 connection, * meaning it will never be assigned the default route by NetworkManager. **/ g_object_class_install_property (object_class, PROP_NEVER_DEFAULT, - g_param_spec_boolean (NM_SETTING_IP4_CONFIG_NEVER_DEFAULT, - "Never default", - "If TRUE, this connection will never be the default " - "IPv4 connection, meaning it will never be assigned " - "the default route by NetworkManager.", - FALSE, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + g_param_spec_boolean (NM_SETTING_IP4_CONFIG_NEVER_DEFAULT, "", "", + FALSE, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); /** * NMSettingIP4Config:may-fail: * - * If TRUE, allow overall network configuration to proceed even if IPv4 - * configuration times out. Note that at least one IP configuration - * must succeed or overall network configuration will still fail. For - * example, in IPv6-only networks, setting this property to TRUE allows - * the overall network configuration to succeed if IPv4 configuration fails - * but IPv6 configuration completes successfully. + * If %TRUE, allow overall network configuration to proceed even if IPv4 + * configuration times out. Note that at least one IP configuration must + * succeed or overall network configuration will still fail. For example, + * in IPv6-only networks, setting this property to %TRUE allows the overall + * network configuration to succeed if IPv4 configuration fails but IPv6 + * configuration completes successfully. **/ g_object_class_install_property (object_class, PROP_MAY_FAIL, - g_param_spec_boolean (NM_SETTING_IP4_CONFIG_MAY_FAIL, - "May Fail", - "If TRUE, allow overall network configuration to " - "proceed even if IPv4 configuration times out. " - "Note that at least one IP configuration must " - "succeed or overall network configuration will still " - "fail. For example, in IPv6-only networks, setting " - "this property to TRUE allows the overall network " - "configuration to succeed if IPv4 configuration " - "fails but IPv6 configuration completes successfully.", - TRUE, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + g_param_spec_boolean (NM_SETTING_IP4_CONFIG_MAY_FAIL, "", "", + TRUE, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); } diff --git a/libnm-util/nm-setting-ip6-config.c b/libnm-util/nm-setting-ip6-config.c index 0d751c4257..708e7b857d 100644 --- a/libnm-util/nm-setting-ip6-config.c +++ b/libnm-util/nm-setting-ip6-config.c @@ -1019,105 +1019,72 @@ nm_setting_ip6_config_class_init (NMSettingIP6ConfigClass *setting_class) /** * NMSettingIP6Config:method: * - * IPv6 configuration method. If 'auto' is specified then the appropriate - * automatic method (DHCP, PPP, advertisement, etc) is used for the - * interface and most other properties can be left unset. To force the use - * of DHCP only, specify 'dhcp'; this method is only valid for ethernet- - * based hardware. If 'link-local' is specified, then an IPv6 link-local - * address will be assigned to the interface. If 'manual' is specified, - * static IP addressing is used and at least one IP address must be given - * in the 'addresses' property. If 'ignore' is specified, IPv6 - * configuration is not done. This property must be set. Note: the 'shared' - * method is not yet supported. + * IPv6 configuration method. If "auto" is specified then the appropriate + * automatic method (PPP, router advertisement, etc) is used for the device + * and most other properties can be left unset. To force the use of DHCP + * only, specify "dhcp"; this method is only valid for Ethernet- based + * hardware. If "link-local" is specified, then an IPv6 link-local address + * will be assigned to the interface. If "manual" is specified, static IP + * addressing is used and at least one IP address must be given in the + * "addresses" property. If "ignore" is specified, IPv6 configuration is + * not done. This property must be set. Note: the "shared" method is not + * yet supported. **/ g_object_class_install_property (object_class, PROP_METHOD, - g_param_spec_string (NM_SETTING_IP6_CONFIG_METHOD, - "Method", - "IPv6 configuration method. If 'auto' is specified " - "then the appropriate automatic method (PPP, router " - "advertisement, etc) is used for the device and " - "most other properties can be left unset. To force " - "the use of DHCP only, specify 'dhcp'; this method " - "is only valid for ethernet-based hardware. If " - "'link-local' is specified, then an IPv6 link-local " - "address will be assigned to the interface. If " - "'manual' is specified, static IP addressing is " - "used and at least one IP address must be given in " - " the 'addresses' property. If 'ignore' is " - "specified, IPv6 configuration is not done. This " - "property must be set. Note: the 'shared' method " - "is not yet supported.", - NULL, - G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE)); + g_param_spec_string (NM_SETTING_IP6_CONFIG_METHOD, "", "", + NULL, + G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingIP6Config:dhcp-hostname: * - * The specified name will be sent to the DHCP server when acquiring a lease. + * The specified name will be sent to the DHCP server when acquiring a + * lease. * * Since: 0.9.8 **/ g_object_class_install_property (object_class, PROP_DHCP_HOSTNAME, - g_param_spec_string (NM_SETTING_IP6_CONFIG_DHCP_HOSTNAME, - "DHCP Hostname", - "The specified name will be sent to the DHCP server " - "when acquiring a lease.", + g_param_spec_string (NM_SETTING_IP6_CONFIG_DHCP_HOSTNAME, "", "", NULL, - G_PARAM_READWRITE)); + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingIP6Config:dns: * * Array of DNS servers, where each member of the array is a byte array * containing the IPv6 address of the DNS server (in network byte order). - * For the 'auto' method, these DNS servers are appended to those (if any) - * returned by automatic configuration. DNS servers cannot be used with - * the 'shared' or 'link-local' methods as there is no usptream network. In - * all other methods, these DNS servers are used as the only DNS servers for + * For the "auto" method, these DNS servers are appended to those (if any) + * returned by automatic configuration. DNS servers cannot be used with the + * "shared" or "link-local" methods as there is no usptream network. In all + * other methods, these DNS servers are used as the only DNS servers for * this connection. **/ g_object_class_install_property (object_class, PROP_DNS, - _nm_param_spec_specialized (NM_SETTING_IP6_CONFIG_DNS, - "DNS", - "Array of DNS servers, where each member of the " - "array is a byte array containing the IPv6 address " - "of the DNS server (in network byte order). For " - "the 'auto' method, these DNS servers are " - "appended to those (if any) returned by automatic " - "configuration. DNS servers cannot be used with " - "the 'shared' or 'link-local' methods as there is " - "no usptream network. In all other methods, " - "these DNS servers are used as the only DNS " - "servers for this connection.", - DBUS_TYPE_G_ARRAY_OF_ARRAY_OF_UCHAR, - G_PARAM_READWRITE)); + _nm_param_spec_specialized (NM_SETTING_IP6_CONFIG_DNS, "", "", + DBUS_TYPE_G_ARRAY_OF_ARRAY_OF_UCHAR, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingIP6Config:dns-search: * - * List of DNS search domains. For the 'auto' method, these search domains + * List of DNS search domains. For the "auto" method, these search domains * are appended to those returned by automatic configuration. Search domains - * cannot be used with the 'shared' or 'link-local' methods as there is no - * upstream network. In all other methods, these search domains are used - * as the only search domains for this connection. + * cannot be used with the "shared" or "link-local" methods as there is no + * upstream network. In all other methods, these search domains are used as + * the only search domains for this connection. **/ g_object_class_install_property (object_class, PROP_DNS_SEARCH, - _nm_param_spec_specialized (NM_SETTING_IP6_CONFIG_DNS_SEARCH, - "DNS search", - "List of DNS search domains. For the 'auto' " - "method, these search domains are appended to " - "those returned by automatic configuration. " - "Search domains cannot be used with the 'shared' " - "or 'link-local' methods as there is no upstream " - "network. In all other methods, these search " - "domains are used as the only search domains for " - "this connection.", - DBUS_TYPE_G_LIST_OF_STRING, - G_PARAM_READWRITE)); + _nm_param_spec_specialized (NM_SETTING_IP6_CONFIG_DNS_SEARCH, "", "", + DBUS_TYPE_G_LIST_OF_STRING, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingIP6Config:addresses: @@ -1127,172 +1094,118 @@ nm_setting_ip6_config_class_init (NMSettingIP6ConfigClass *setting_class) * address (network byte order), the second a 32-bit integer containing the * IPv6 address prefix, and the third a byte array containing the IPv6 * address (network byte order) of the gateway associated with this address, - * if any. If no gateway is given, the third element should be given as - * all zeros. For the 'auto' method, given IP addresses are appended to - * those returned by automatic configuration. Addresses cannot be used with - * the 'shared' or 'link-local' methods as the interface is automatically + * if any. If no gateway is given, the third element should be given as all + * zeros. For the "auto" method, given IP addresses are appended to those + * returned by automatic configuration. Addresses cannot be used with the + * "shared" or "link-local" methods as the interface is automatically * assigned an address with these methods. **/ g_object_class_install_property (object_class, PROP_ADDRESSES, - _nm_param_spec_specialized (NM_SETTING_IP6_CONFIG_ADDRESSES, - "Addresses", - "Array of IPv6 address structures. Each IPv6 " - "address structure is composed of 3 members, the " - "first being a byte array containing the IPv6 " - "address (network byte order), the second a " - "32-bit integer containing the IPv6 address " - "prefix, and the third a byte array containing " - "the IPv6 address (network byte order) of the " - "gateway associated with this address, if any. " - "If no gateway is given, the third element should " - "be given as all zeros. For the 'auto' method, " - "given IP addresses are appended to those returned " - "by automatic configuration. Addresses cannot be " - "used with the 'shared' or 'link-local' methods " - "as the interface is automatically assigned an " - "address with these methods.", - DBUS_TYPE_G_ARRAY_OF_IP6_ADDRESS, - G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE)); + _nm_param_spec_specialized (NM_SETTING_IP6_CONFIG_ADDRESSES, "", "", + DBUS_TYPE_G_ARRAY_OF_IP6_ADDRESS, + G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingIP6Config:routes: * - * Array of IPv6 route structures. Each IPv6 route structure is composed - * of 4 members; the first being the destination IPv6 network or - * address (network byte order) as a byte array, the second the destination - * network or address IPv6 prefix, the third being the next-hop IPv6 address + * Array of IPv6 route structures. Each IPv6 route structure is composed of + * 4 members; the first being the destination IPv6 network or address + * (network byte order) as a byte array, the second the destination network + * or address IPv6 prefix, the third being the next-hop IPv6 address * (network byte order) if any, and the fourth being the route metric. For - * the 'auto' method, given IP routes are appended to those returned by - * automatic configuration. Routes cannot be used with the 'shared' or - * 'link-local' methods because there is no upstream network. + * the "auto" method, given IP routes are appended to those returned by + * automatic configuration. Routes cannot be used with the "shared" or + * "link-local" methods because there is no upstream network. **/ g_object_class_install_property (object_class, PROP_ROUTES, - _nm_param_spec_specialized (NM_SETTING_IP6_CONFIG_ROUTES, - "Routes", - "Array of IPv6 route structures. Each IPv6 route " - "structure is composed of 4 members; the first " - "being the destination IPv6 network or address " - "(network byte order) as a byte array, the second " - "the destination network or address IPv6 prefix, " - "the third being the next-hop IPv6 address " - "(network byte order) if any, and the fourth " - "being the route metric. For the 'auto' method, " - "given IP routes are appended to those returned " - "by automatic configuration. Routes cannot be " - "used with the 'shared' or 'link-local' methods " - "because there is no upstream network.", - DBUS_TYPE_G_ARRAY_OF_IP6_ROUTE, - G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE)); + _nm_param_spec_specialized (NM_SETTING_IP6_CONFIG_ROUTES, "", "", + DBUS_TYPE_G_ARRAY_OF_IP6_ROUTE, + G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingIP6Config:ignore-auto-routes: * - * When the method is set to 'auto' or 'dhcp' and this property is set to - * TRUE, automatically configured routes are ignored and only routes - * specified in #NMSettingIP6Config:routes, if any, are used. + * When the method is set to "auto" or "dhcp" and this property is set to + * %TRUE, automatically configured routes are ignored and only routes + * specified in the #NMSettingIP6Config:routes property, if any, are used. **/ g_object_class_install_property (object_class, PROP_IGNORE_AUTO_ROUTES, - g_param_spec_boolean (NM_SETTING_IP6_CONFIG_IGNORE_AUTO_ROUTES, - "Ignore automatic routes", - "When the method is set to 'auto' or 'dhcp' and this " - "property is set to TRUE, automatically configured " - "routes are ignored and only routes specified in the " - "'routes' property, if any, are used.", - FALSE, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + g_param_spec_boolean (NM_SETTING_IP6_CONFIG_IGNORE_AUTO_ROUTES, "", "", + FALSE, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); /** * NMSettingIP6Config:ignore-auto-dns: * - * When the method is set to 'auto' or 'dhcp' and this property is set to - * TRUE, automatically configured nameservers and search domains are ignored - * and only nameservers and search domains specified in - * #NMSettingIP6Config:dns and #NMSettingIP6Config:dns-search, if any, are - * used. + * When the method is set to "auto" or "dhcp" and this property is set to + * %TRUE, automatically configured nameservers and search domains are + * ignored and only nameservers and search domains specified in the + * #NMSettingIP6Config:dns and #NMSettingIP6Config:dns-search properties, if + * any, are used. **/ g_object_class_install_property (object_class, PROP_IGNORE_AUTO_DNS, - g_param_spec_boolean (NM_SETTING_IP6_CONFIG_IGNORE_AUTO_DNS, - "Ignore DHCPv6/RDNSS DNS", - "When the method is set to 'auto' or 'dhcp' and this " - "property is set to TRUE, automatically configured " - "nameservers and search domains are ignored and only " - "nameservers and search domains specified in the 'dns' " - "and 'dns-search' properties, if any, are used.", - FALSE, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + g_param_spec_boolean (NM_SETTING_IP6_CONFIG_IGNORE_AUTO_DNS, "", "", + FALSE, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); /** * NMSettingIP6Config:never-default: * - * If TRUE, this connection will never be the default IPv6 connection, - * meaning it will never be assigned the default IPv6 route by NetworkManager. + * If %TRUE, this connection will never be the default IPv6 connection, + * meaning it will never be assigned the default IPv6 route by + * NetworkManager. **/ g_object_class_install_property (object_class, PROP_NEVER_DEFAULT, - g_param_spec_boolean (NM_SETTING_IP6_CONFIG_NEVER_DEFAULT, - "Never default", - "If TRUE, this connection will never be the default " - "IPv6 connection, meaning it will never be assigned " - "the default IPv6 route by NetworkManager.", - FALSE, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + g_param_spec_boolean (NM_SETTING_IP6_CONFIG_NEVER_DEFAULT, "", "", + FALSE, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); /** * NMSettingIP6Config:may-fail: * - * If TRUE, allow overall network configuration to proceed even if IPv6 - * configuration times out. Note that at least one IP configuration - * must succeed or overall network configuration will still fail. For - * example, in IPv4-only networks, setting this property to TRUE allows - * the overall network configuration to succeed if IPv6 configuration fails - * but IPv4 configuration completes successfully. + * If %TRUE, allow overall network configuration to proceed even if IPv6 + * configuration times out. Note that at least one IP configuration must + * succeed or overall network configuration will still fail. For example, + * in IPv4-only networks, setting this property to %TRUE allows the overall + * network configuration to succeed if IPv6 configuration fails but IPv4 + * configuration completes successfully. **/ g_object_class_install_property (object_class, PROP_MAY_FAIL, - g_param_spec_boolean (NM_SETTING_IP6_CONFIG_MAY_FAIL, - "May Fail", - "If TRUE, allow overall network configuration to " - "proceed even if IPv6 configuration times out. " - "Note that at least one IP configuration must " - "succeed or overall network configuration will still " - "fail. For example, in IPv4-only networks, setting " - "this property to TRUE allows the overall network " - "configuration to succeed if IPv6 configuration " - "fails but IPv4 configuration completes successfully.", - TRUE, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + g_param_spec_boolean (NM_SETTING_IP6_CONFIG_MAY_FAIL, "", "", + TRUE, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); /** * NMSettingIP6Config:ip6-privacy: * - * Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941. - * If enabled, it makes the kernel generate a temporary IPv6 address - * in addition to the public one generated from MAC address via - * modified EUI-64. This enhances privacy, but could cause problems - * in some applications, on the other hand. The permitted values - * are: 0: disabled, 1: enabled (prefer public address), - * 2: enabled (prefer temporary addresses). + * Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941. If + * enabled, it makes the kernel generate a temporary IPv6 address in + * addition to the public one generated from MAC address via modified + * EUI-64. This enhances privacy, but could cause problems in some + * applications, on the other hand. The permitted values are: 0: disabled, + * 1: enabled (prefer public address), 2: enabled (prefer temporary + * addresses). **/ g_object_class_install_property (object_class, PROP_IP6_PRIVACY, - g_param_spec_int (NM_SETTING_IP6_CONFIG_IP6_PRIVACY, - "Configure IPv6 Privacy", - "Configure IPv6 Privacy Extensions for SLAAC, described " - "in RFC4941. If enabled, it makes the kernel generate " - "a temporary IPv6 address in addition to the public one " - "generated from MAC address via modified EUI-64. This " - "enhances privacy, but could cause problems in some " - "applications, on the other hand. The permitted values " - "are: 0: disabled, 1: enabled (prefer public address), " - "2: enabled (prefer temporary addresses).", + g_param_spec_int (NM_SETTING_IP6_CONFIG_IP6_PRIVACY, "", "", NM_SETTING_IP6_CONFIG_PRIVACY_UNKNOWN, NM_SETTING_IP6_CONFIG_PRIVACY_PREFER_TEMP_ADDR, NM_SETTING_IP6_CONFIG_PRIVACY_UNKNOWN, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); } /********************************************************************/ diff --git a/libnm-util/nm-setting-olpc-mesh.c b/libnm-util/nm-setting-olpc-mesh.c index 3bff35da92..462b80b958 100644 --- a/libnm-util/nm-setting-olpc-mesh.c +++ b/libnm-util/nm-setting-olpc-mesh.c @@ -243,11 +243,10 @@ nm_setting_olpc_mesh_class_init (NMSettingOlpcMeshClass *setting_class) **/ g_object_class_install_property (object_class, PROP_SSID, - _nm_param_spec_specialized (NM_SETTING_OLPC_MESH_SSID, - "SSID", - "SSID of the mesh network to join.", + _nm_param_spec_specialized (NM_SETTING_OLPC_MESH_SSID, "", "", DBUS_TYPE_G_UCHAR_ARRAY, - G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE)); + G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingOlpcMesh:channel: @@ -256,28 +255,22 @@ nm_setting_olpc_mesh_class_init (NMSettingOlpcMeshClass *setting_class) **/ g_object_class_install_property (object_class, PROP_CHANNEL, - g_param_spec_uint (NM_SETTING_OLPC_MESH_CHANNEL, - "Channel", - "Channel on which the mesh network to join is located.", + g_param_spec_uint (NM_SETTING_OLPC_MESH_CHANNEL, "", "", 0, G_MAXUINT32, 0, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_INFERRABLE)); + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingOlpcMesh:dhcp-anycast-address: * - * Anycast DHCP address used when requesting an IP address via DHCP. The - * specific anycast address used determines which DHCP server class answers - * the request. + * Anycast DHCP MAC address used when requesting an IP address via DHCP. + * The specific anycast address used determines which DHCP server class + * answers the request. **/ g_object_class_install_property (object_class, PROP_DHCP_ANYCAST_ADDRESS, - _nm_param_spec_specialized (NM_SETTING_OLPC_MESH_DHCP_ANYCAST_ADDRESS, - "Anycast DHCP MAC address", - "Anycast DHCP MAC address used when " - "requesting an IP address via DHCP. The " - "specific anycast address used determines " - "which DHCP server class answers the " - "the request.", + _nm_param_spec_specialized (NM_SETTING_OLPC_MESH_DHCP_ANYCAST_ADDRESS, "", "", DBUS_TYPE_G_UCHAR_ARRAY, - G_PARAM_READWRITE)); + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); } diff --git a/libnm-util/nm-setting-ppp.c b/libnm-util/nm-setting-ppp.c index 2e939c28be..f7c3317550 100644 --- a/libnm-util/nm-setting-ppp.c +++ b/libnm-util/nm-setting-ppp.c @@ -566,196 +566,168 @@ nm_setting_ppp_class_init (NMSettingPPPClass *setting_class) /** * NMSettingPPP:noauth: * - * If TRUE, do not require the other side (usually the PPP server) to - * authenticate itself to the client. If FALSE, require authentication from - * the remote side. In almost all cases, this should be TRUE. + * If %TRUE, do not require the other side (usually the PPP server) to + * authenticate itself to the client. If %FALSE, require authentication + * from the remote side. In almost all cases, this should be %TRUE. **/ g_object_class_install_property (object_class, PROP_NOAUTH, - g_param_spec_boolean (NM_SETTING_PPP_NOAUTH, - "NoAuth", - "If TRUE, do not require the other side (usually the " - "PPP server) to authenticate itself to the client. " - "If FALSE, require authentication from the remote " - "side. In almost all cases, this should be TRUE.", - TRUE, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + g_param_spec_boolean (NM_SETTING_PPP_NOAUTH, "", "", + TRUE, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); /** * NMSettingPPP:refuse-eap: * - * If TRUE, the EAP authentication method will not be used. + * If %TRUE, the EAP authentication method will not be used. **/ g_object_class_install_property (object_class, PROP_REFUSE_EAP, - g_param_spec_boolean (NM_SETTING_PPP_REFUSE_EAP, - "Refuse EAP", - "If TRUE, the EAP authentication method will not be used.", - FALSE, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + g_param_spec_boolean (NM_SETTING_PPP_REFUSE_EAP, "", "", + FALSE, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); /** * NMSettingPPP:refuse-pap: * - * If TRUE, the PAP authentication method will not be used. + * If %TRUE, the PAP authentication method will not be used. **/ g_object_class_install_property (object_class, PROP_REFUSE_PAP, - g_param_spec_boolean (NM_SETTING_PPP_REFUSE_PAP, - "Refuse PAP", - "If TRUE, the PAP authentication method will not be used.", - FALSE, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + g_param_spec_boolean (NM_SETTING_PPP_REFUSE_PAP, "", "", + FALSE, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); /** * NMSettingPPP:refuse-chap: * - * If TRUE, the CHAP authentication method will not be used. + * If %TRUE, the CHAP authentication method will not be used. **/ g_object_class_install_property (object_class, PROP_REFUSE_CHAP, - g_param_spec_boolean (NM_SETTING_PPP_REFUSE_CHAP, - "Refuse CHAP", - "If TRUE, the CHAP authentication method will not be used.", - FALSE, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + g_param_spec_boolean (NM_SETTING_PPP_REFUSE_CHAP, "", "", + FALSE, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); /** * NMSettingPPP:refuse-mschap: * - * If TRUE, the MSCHAP authentication method will not be used. + * If %TRUE, the MSCHAP authentication method will not be used. **/ g_object_class_install_property (object_class, PROP_REFUSE_MSCHAP, - g_param_spec_boolean (NM_SETTING_PPP_REFUSE_MSCHAP, - "Refuse MSCHAP", - "If TRUE, the MSCHAP authentication method will not be used.", - FALSE, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + g_param_spec_boolean (NM_SETTING_PPP_REFUSE_MSCHAP, "", "", + FALSE, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); /** * NMSettingPPP:refuse-mschapv2: * - * If TRUE, the MSCHAPv2 authentication method will not be used. + * If %TRUE, the MSCHAPv2 authentication method will not be used. **/ g_object_class_install_property (object_class, PROP_REFUSE_MSCHAPV2, - g_param_spec_boolean (NM_SETTING_PPP_REFUSE_MSCHAPV2, - "Refuse MSCHAPv2", - "If TRUE, the MSCHAPv2 authentication method will not be used.", - FALSE, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + g_param_spec_boolean (NM_SETTING_PPP_REFUSE_MSCHAPV2, "", "", + FALSE, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); /** * NMSettingPPP:nobsdcomp: * - * If TRUE, BSD compression will not be requested. + * If %TRUE, BSD compression will not be requested. **/ g_object_class_install_property (object_class, PROP_NOBSDCOMP, - g_param_spec_boolean (NM_SETTING_PPP_NOBSDCOMP, - "No BSD compression", - "If TRUE, BSD compression will not be requested.", - FALSE, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_FUZZY_IGNORE)); + g_param_spec_boolean (NM_SETTING_PPP_NOBSDCOMP, "", "", + FALSE, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_FUZZY_IGNORE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingPPP:nodeflate: * - * If TRUE, 'deflate' compression will not be requested. + * If %TRUE, "deflate" compression will not be requested. **/ g_object_class_install_property (object_class, PROP_NODEFLATE, - g_param_spec_boolean (NM_SETTING_PPP_NODEFLATE, - "No deflate", - "If TRUE, 'deflate' compression will not be requested.", - FALSE, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_FUZZY_IGNORE)); + g_param_spec_boolean (NM_SETTING_PPP_NODEFLATE, "", "", + FALSE, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_FUZZY_IGNORE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingPPP:no-vj-comp: * - * If TRUE, Van Jacobsen TCP header compression will not be requested. + * If %TRUE, Van Jacobsen TCP header compression will not be requested. **/ g_object_class_install_property (object_class, PROP_NO_VJ_COMP, - g_param_spec_boolean (NM_SETTING_PPP_NO_VJ_COMP, - "No VJ compression", - "If TRUE, Van Jacobsen TCP header compression will not be requested.", - FALSE, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_FUZZY_IGNORE)); + g_param_spec_boolean (NM_SETTING_PPP_NO_VJ_COMP, "", "", + FALSE, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_FUZZY_IGNORE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingPPP:require-mppe: * - * If TRUE, MPPE (Microsoft Point-to-Point Encrpytion) will be required for + * If %TRUE, MPPE (Microsoft Point-to-Point Encrpytion) will be required for * the PPP session. If either 64-bit or 128-bit MPPE is not available the * session will fail. Note that MPPE is not used on mobile broadband * connections. **/ g_object_class_install_property (object_class, PROP_REQUIRE_MPPE, - g_param_spec_boolean (NM_SETTING_PPP_REQUIRE_MPPE, - "Require MPPE", - "If TRUE, MPPE (Microsoft Point-to-Point Encrpytion) " - "will be required for the PPP session. If either " - "64-bit or 128-bit MPPE is not available the session " - "will fail. Note that MPPE is not used on mobile " - "broadband connections.", - FALSE, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + g_param_spec_boolean (NM_SETTING_PPP_REQUIRE_MPPE, "", "", + FALSE, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); /** * NMSettingPPP:require-mppe-128: * - * If TRUE, 128-bit MPPE (Microsoft Point-to-Point Encrpytion) will be - * required for the PPP session, and the 'require-mppe' property must also - * be set to TRUE. If 128-bit MPPE is not available the session will fail. + * If %TRUE, 128-bit MPPE (Microsoft Point-to-Point Encrpytion) will be + * required for the PPP session, and the "require-mppe" property must also + * be set to %TRUE. If 128-bit MPPE is not available the session will fail. **/ g_object_class_install_property (object_class, PROP_REQUIRE_MPPE_128, - g_param_spec_boolean (NM_SETTING_PPP_REQUIRE_MPPE_128, - "Require MPPE 128", - "If TRUE, 128-bit MPPE (Microsoft Point-to-Point " - "Encrpytion) will be required for the PPP session, " - "and the '" NM_SETTING_PPP_REQUIRE_MPPE "' property " - "must also be set to TRUE. If 128-bit MPPE is not " - "available the session will fail.", - FALSE, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + g_param_spec_boolean (NM_SETTING_PPP_REQUIRE_MPPE_128, "", "", + FALSE, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); /** * NMSettingPPP:mppe-stateful: * - * If TRUE, stateful MPPE is used. See pppd documentation for more - * information on stateful MPPE.", + * If %TRUE, stateful MPPE is used. See pppd documentation for more + * information on stateful MPPE. **/ g_object_class_install_property (object_class, PROP_MPPE_STATEFUL, - g_param_spec_boolean (NM_SETTING_PPP_MPPE_STATEFUL, - "MPPE stateful", - "If TRUE, stateful MPPE is used. See pppd documentation " - "for more information on stateful MPPE.", - FALSE, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + g_param_spec_boolean (NM_SETTING_PPP_MPPE_STATEFUL, "", "", + FALSE, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); /** * NMSettingPPP:crtscts: * - * If TRUE, specify that pppd should set the serial port to use hardware - * flow control with RTS and CTS signals. This value should normally be - * set to FALSE. + * If %TRUE, specify that pppd should set the serial port to use hardware + * flow control with RTS and CTS signals. This value should normally be set + * to %FALSE. **/ g_object_class_install_property (object_class, PROP_CRTSCTS, - g_param_spec_boolean (NM_SETTING_PPP_CRTSCTS, - "CRTSCTS", - "If TRUE, specify that pppd should set the serial " - "port to use hardware flow control with RTS and CTS " - "signals. This value should normally be set to " - "FALSE.", - FALSE, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + g_param_spec_boolean (NM_SETTING_PPP_CRTSCTS, "", "", + FALSE, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); /** * NMSettingPPP:baud: @@ -766,13 +738,10 @@ nm_setting_ppp_class_init (NMSettingPPPClass *setting_class) **/ g_object_class_install_property (object_class, PROP_BAUD, - g_param_spec_uint (NM_SETTING_PPP_BAUD, - "Baud", - "If non-zero, instruct pppd to set the serial port to " - "the specified baudrate. This value should normally be " - "left as 0 to automatically choose the speed.", - 0, G_MAXUINT32, 0, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_FUZZY_IGNORE)); + g_param_spec_uint (NM_SETTING_PPP_BAUD, "", "", + 0, G_MAXUINT32, 0, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_FUZZY_IGNORE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingPPP:mru: @@ -783,13 +752,10 @@ nm_setting_ppp_class_init (NMSettingPPPClass *setting_class) */ g_object_class_install_property (object_class, PROP_MRU, - g_param_spec_uint (NM_SETTING_PPP_MRU, - "MRU", - "If non-zero, instruct pppd to request that the peer " - "send packets no larger than the specified size. If " - "non-zero, the MRU should be between 128 and 16384.", - 0, 16384, 0, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + g_param_spec_uint (NM_SETTING_PPP_MRU, "", "", + 0, 16384, 0, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); /** * NMSettingPPP:mtu: @@ -799,33 +765,25 @@ nm_setting_ppp_class_init (NMSettingPPPClass *setting_class) **/ g_object_class_install_property (object_class, PROP_MTU, - g_param_spec_uint (NM_SETTING_PPP_MTU, - "MTU", - "If non-zero, instruct pppd to send packets no larger " - "than the specified size.", - 0, G_MAXUINT32, 0, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_FUZZY_IGNORE)); + g_param_spec_uint (NM_SETTING_PPP_MTU, "", "", + 0, G_MAXUINT32, 0, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_FUZZY_IGNORE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingPPP:lcp-echo-failure: * * If non-zero, instruct pppd to presume the connection to the peer has * failed if the specified number of LCP echo-requests go unanswered by the - * peer. The 'lcp-echo-interval' property must also be set to a non-zero + * peer. The "lcp-echo-interval" property must also be set to a non-zero * value if this property is used. **/ g_object_class_install_property (object_class, PROP_LCP_ECHO_FAILURE, - g_param_spec_uint (NM_SETTING_PPP_LCP_ECHO_FAILURE, - "LCP echo failure", - "If non-zero, instruct pppd to presume the connection to " - "the peer has failed if the specified number of LCP " - "echo-requests go unanswered by the peer. The " - "'" NM_SETTING_PPP_LCP_ECHO_INTERVAL "' property must " - "also be set to a non-zero value if this property is " - "used.", - 0, G_MAXUINT32, 0, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_FUZZY_IGNORE)); + g_param_spec_uint (NM_SETTING_PPP_LCP_ECHO_FAILURE, "", "", + 0, G_MAXUINT32, 0, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_FUZZY_IGNORE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingPPP:lcp-echo-interval: @@ -837,13 +795,8 @@ nm_setting_ppp_class_init (NMSettingPPPClass *setting_class) **/ g_object_class_install_property (object_class, PROP_LCP_ECHO_INTERVAL, - g_param_spec_uint (NM_SETTING_PPP_LCP_ECHO_INTERVAL, - "LCP echo interval", - "If non-zero, instruct pppd to send an LCP echo-request " - "frame to the peer every n seconds (where n is the " - "specified value). Note that some PPP peers will respond " - "to echo requests and some will not, and it is not " - "possible to autodetect this.", - 0, G_MAXUINT32, 0, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_FUZZY_IGNORE)); + g_param_spec_uint (NM_SETTING_PPP_LCP_ECHO_INTERVAL, "", "", + 0, G_MAXUINT32, 0, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_FUZZY_IGNORE | + G_PARAM_STATIC_STRINGS)); } diff --git a/libnm-util/nm-setting-pppoe.c b/libnm-util/nm-setting-pppoe.c index 2ea29a6e6d..6e57e987b0 100644 --- a/libnm-util/nm-setting-pppoe.c +++ b/libnm-util/nm-setting-pppoe.c @@ -299,16 +299,10 @@ nm_setting_pppoe_class_init (NMSettingPPPOEClass *setting_class) **/ g_object_class_install_property (object_class, PROP_SERVICE, - g_param_spec_string (NM_SETTING_PPPOE_SERVICE, - "Service", - "If specified, instruct PPPoE to only initiate sessions " - "with access concentrators that provide the specified " - "service. For most providers, this should be left " - "blank. It is only required if there are multiple " - "access concentrators or a specific service is known " - "to be required.", - NULL, - G_PARAM_READWRITE)); + g_param_spec_string (NM_SETTING_PPPOE_SERVICE, "", "", + NULL, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingPPPOE:username: @@ -317,11 +311,10 @@ nm_setting_pppoe_class_init (NMSettingPPPOEClass *setting_class) **/ g_object_class_install_property (object_class, PROP_USERNAME, - g_param_spec_string (NM_SETTING_PPPOE_USERNAME, - "Username", - "Username used to authenticate with the PPPoE service.", - NULL, - G_PARAM_READWRITE)); + g_param_spec_string (NM_SETTING_PPPOE_USERNAME, "", "", + NULL, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingPPPOE:password: @@ -330,23 +323,22 @@ nm_setting_pppoe_class_init (NMSettingPPPOEClass *setting_class) **/ g_object_class_install_property (object_class, PROP_PASSWORD, - g_param_spec_string (NM_SETTING_PPPOE_PASSWORD, - "Password", - "Password used to authenticate with the PPPoE service.", - NULL, - G_PARAM_READWRITE | NM_SETTING_PARAM_SECRET)); + g_param_spec_string (NM_SETTING_PPPOE_PASSWORD, "", "", + NULL, + G_PARAM_READWRITE | NM_SETTING_PARAM_SECRET | + G_PARAM_STATIC_STRINGS)); /** * NMSettingPPPOE:password-flags: * - * Flags indicating how to handle #NMSettingPPPOE:password:. + * Flags indicating how to handle the #NMSettingPPPOE:password property. **/ - g_object_class_install_property (object_class, PROP_PASSWORD_FLAGS, - g_param_spec_uint (NM_SETTING_PPPOE_PASSWORD_FLAGS, - "Password Flags", - "Flags indicating how to handle the PPPoE password.", + g_object_class_install_property + (object_class, PROP_PASSWORD_FLAGS, + g_param_spec_uint (NM_SETTING_PPPOE_PASSWORD_FLAGS, "", "", NM_SETTING_SECRET_FLAG_NONE, NM_SETTING_SECRET_FLAGS_ALL, NM_SETTING_SECRET_FLAG_NONE, - G_PARAM_READWRITE)); + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); } diff --git a/libnm-util/nm-setting-serial.c b/libnm-util/nm-setting-serial.c index 2cb80c368e..f0d26fad9f 100644 --- a/libnm-util/nm-setting-serial.c +++ b/libnm-util/nm-setting-serial.c @@ -255,34 +255,28 @@ nm_setting_serial_class_init (NMSettingSerialClass *setting_class) /** * NMSettingSerial:baud: * - * Speed to use for communication over the serial port. Note that this value - * usually has no effect for mobile broadband modems as they generally + * Speed to use for communication over the serial port. Note that this + * value usually has no effect for mobile broadband modems as they generally * ignore speed settings and use the highest available speed. **/ g_object_class_install_property (object_class, PROP_BAUD, - g_param_spec_uint (NM_SETTING_SERIAL_BAUD, - "Baud", - "Speed to use for communication over the serial port. " - "Note that this value usually has no effect for mobile " - "broadband modems as they generally ignore speed " - "settings and use the highest available speed.", - 0, G_MAXUINT, 57600, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + g_param_spec_uint (NM_SETTING_SERIAL_BAUD, "", "", + 0, G_MAXUINT, 57600, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); /** * NMSettingSerial:bits: * - * Byte-width of the serial communication. + * Byte-width of the serial communication. The 8 in "8n1" for example. **/ g_object_class_install_property (object_class, PROP_BITS, - g_param_spec_uint (NM_SETTING_SERIAL_BITS, - "Bits", - "Byte-width of the serial communication. The 8 in " - "'8n1' for example.", - 5, 8, 8, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + g_param_spec_uint (NM_SETTING_SERIAL_BITS, "", "", + 5, 8, 8, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); /** * NMSettingSerial:parity: @@ -292,27 +286,23 @@ nm_setting_serial_class_init (NMSettingSerialClass *setting_class) **/ g_object_class_install_property (object_class, PROP_PARITY, - g_param_spec_char (NM_SETTING_SERIAL_PARITY, - "Parity", - "Parity setting of the serial port. Either 'E' for even " - "parity, 'o' for odd parity, or 'n' for no parity.", - 'E', 'o', 'n', - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + g_param_spec_char (NM_SETTING_SERIAL_PARITY, "", "", + 'E', 'o', 'n', + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); /** * NMSettingSerial:stopbits: * * Number of stop bits for communication on the serial port. Either 1 or 2. - * The 1 in '8n1' for example. + * The 1 in "8n1" for example. **/ g_object_class_install_property (object_class, PROP_STOPBITS, - g_param_spec_uint (NM_SETTING_SERIAL_STOPBITS, - "Stopbits", - "Number of stop bits for communication on the serial " - "port. Either 1 or 2. The 1 in '8n1' for example.", - 1, 2, 1, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + g_param_spec_uint (NM_SETTING_SERIAL_STOPBITS, "", "", + 1, 2, 1, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); /** * NMSettingSerial:send-delay: @@ -321,10 +311,8 @@ nm_setting_serial_class_init (NMSettingSerialClass *setting_class) **/ g_object_class_install_property (object_class, PROP_SEND_DELAY, - g_param_spec_uint64 (NM_SETTING_SERIAL_SEND_DELAY, - "SendDelay", - "Time to delay between each byte sent to the modem, " - "in microseconds.", - 0, G_MAXUINT64, 0, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + g_param_spec_uint64 (NM_SETTING_SERIAL_SEND_DELAY, "", "", + 0, G_MAXUINT64, 0, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); } diff --git a/libnm-util/nm-setting-team-port.c b/libnm-util/nm-setting-team-port.c index c041927507..a14b0f099e 100644 --- a/libnm-util/nm-setting-team-port.c +++ b/libnm-util/nm-setting-team-port.c @@ -169,22 +169,15 @@ nm_setting_team_port_class_init (NMSettingTeamPortClass *setting_class) /** * NMSettingTeamPort:config: * - * The config of team port - * JSON configuration for the team port. - * The property should contain raw JSON configuration data - * suitable for teamd, because the value is passed directly to - * teamd. If not specified, the default configuration is used. - * See man teamd.conf for the format details. + * The JSON configuration for the team port. The property should contain raw + * JSON configuration data suitable for teamd, because the value is passed + * directly to teamd. If not specified, the default configuration is + * used. See man teamd.conf for the format details. **/ g_object_class_install_property (object_class, PROP_CONFIG, - g_param_spec_string (NM_SETTING_TEAM_PORT_CONFIG, - "Config", - "JSON configuration for the team port. " - "The property should contain raw JSON configuration data " - "suitable for teamd, because the value is passed directly to " - "teamd. If not specified, the dafault configuration is used. " - "See man teamd.conf for the format details.", + g_param_spec_string (NM_SETTING_TEAM_PORT_CONFIG, "", "", NULL, - G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE)); + G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); } diff --git a/libnm-util/nm-setting-team.c b/libnm-util/nm-setting-team.c index 80885b22da..4cfec4c9e3 100644 --- a/libnm-util/nm-setting-team.c +++ b/libnm-util/nm-setting-team.c @@ -242,30 +242,23 @@ nm_setting_team_class_init (NMSettingTeamClass *setting_class) **/ g_object_class_install_property (object_class, PROP_INTERFACE_NAME, - g_param_spec_string (NM_SETTING_TEAM_INTERFACE_NAME, - "InterfaceName", - "The name of the virtual in-kernel team network interface", + g_param_spec_string (NM_SETTING_TEAM_INTERFACE_NAME, "", "", NULL, - G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE)); + G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingTeam:config: * - * JSON configuration for the team network interface. - * The property should contain raw JSON configuration data - * suitable for teamd, because the value is passed directly to - * teamd. If not specified, the default configuration is used. - * See man teamd.conf for the format details. + * The JSON configuration for the team network interface. The property + * should contain raw JSON configuration data suitable for teamd, because + * the value is passed directly to teamd. If not specified, the default + * configuration is used. See man teamd.conf for the format details. **/ g_object_class_install_property (object_class, PROP_CONFIG, - g_param_spec_string (NM_SETTING_TEAM_CONFIG, - "Config", - "JSON configuration for the team network interface. " - "The property should contain raw JSON configuration data " - "suitable for teamd, because the value is passed directly to " - "teamd. If not specified, the default configuration is used. " - "See man teamd.conf for the format details.", + g_param_spec_string (NM_SETTING_TEAM_CONFIG, "", "", NULL, - G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE)); + G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); } diff --git a/libnm-util/nm-setting-vlan.c b/libnm-util/nm-setting-vlan.c index 707ee222f3..ac9a02a598 100644 --- a/libnm-util/nm-setting-vlan.c +++ b/libnm-util/nm-setting-vlan.c @@ -752,113 +752,86 @@ nm_setting_vlan_class_init (NMSettingVlanClass *setting_class) * * If given, specifies the kernel name of the VLAN interface. If not given, * a default name will be constructed from the interface described by the - * parent interface and the #NMSettingVlan:id , ex 'eth2.1'. The parent - * interface may be given by the #NMSettingVlan:parent property or by the - * #NMSettingWired:mac-address property of an #NMSettingWired. + * parent interface and the #NMSettingVlan:id property, eg "eth2.1". The + * parent interface may be given by the #NMSettingVlan:parent property or by + * the #NMSettingWired:mac-address property of an #NMSettingWired setting. **/ g_object_class_install_property (object_class, PROP_INTERFACE_NAME, - g_param_spec_string (NM_SETTING_VLAN_INTERFACE_NAME, - "InterfaceName", - "If given, specifies the kernel name of the VLAN " - "interface. If not given, a default name will be " - "constructed from the interface described by the " - "parent interface and the 'id' property, ex " - "'eth2.1'. The parent interface may be given by " - "the 'parent' property or by the 'mac-address' " - "property of a 'wired' setting.", - NULL, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_INFERRABLE)); + g_param_spec_string (NM_SETTING_VLAN_INTERFACE_NAME, "", "", + NULL, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingVlan:parent: * * If given, specifies the parent interface name or parent connection UUID * from which this VLAN interface should be created. If this property is - * not specified, the connection must contain a #NMSettingWired:mac-address - * in an #NMSettingWired setting. + * not specified, the connection must contain an #NMSettingWired setting + * with a #NMSettingWired:mac-address property. **/ g_object_class_install_property (object_class, PROP_PARENT, - g_param_spec_string (NM_SETTING_VLAN_PARENT, - "Parent", - "If given, specifies the parent interface name or " - "parent connection UUID from which this VLAN " - "interface should be created. If this property is " - "not specified, the connection must contain a " - "'wired' setting with a 'mac-address' property.", - NULL, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_INFERRABLE)); + g_param_spec_string (NM_SETTING_VLAN_PARENT, "", "", + NULL, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingVlan:id: * - * The VLAN identifier the interface created by this connection should be - * assigned. + * The VLAN identifier that the interface created by this connection should + * be assigned. **/ g_object_class_install_property (object_class, PROP_ID, - g_param_spec_uint (NM_SETTING_VLAN_ID, - "VLAN ID", - "The VLAN indentifier the interface created by " - "this connection should be assigned.", + g_param_spec_uint (NM_SETTING_VLAN_ID, "", "", 0, 4095, 0, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_INFERRABLE)); + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingVlan:flags: * - * One or more of %NMVlanFlags which control the behavior and features of - * the VLAN interface. + * One or more flags which control the behavior and features of the VLAN + * interface. Flags include %NM_VLAN_FLAG_REORDER_HEADERS (reordering of + * output packet headers), %NM_VLAN_FLAG_GVRP (use of the GVRP protocol), + * and %NM_VLAN_FLAG_LOOSE_BINDING (loose binding of the interface to its + * master device's operating state). **/ g_object_class_install_property (object_class, PROP_FLAGS, - g_param_spec_uint (NM_SETTING_VLAN_FLAGS, - "VLAN flags", - "One or more flags which control the behavior and " - "features of the VLAN interface. Flags include " - "reordering of output packet headers (0x01), use " - "of the GVRP protocol (0x02), and loose binding " - "of the interface to its master device's operating " - "state (0x04).", + g_param_spec_uint (NM_SETTING_VLAN_FLAGS, "", "", 0, G_MAXUINT32, 0, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_INFERRABLE)); + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingVlan:ingress-priority-map: * * For incoming packets, a list of mappings from 802.1p priorities to Linux - * SKB priorities. The mapping is given in the format 'from:to' where both - * 'from' and 'to' are unsigned integers, ie '7:3'. + * SKB priorities. The mapping is given in the format "from:to" where both + * "from" and "to" are unsigned integers, ie "7:3". **/ g_object_class_install_property (object_class, PROP_INGRESS_PRIORITY_MAP, - _nm_param_spec_specialized (NM_SETTING_VLAN_INGRESS_PRIORITY_MAP, - "VLAN ingress priority mapping", - "For incoming packets, a list of mappings " - "from 802.1p priorities to Linux SKB " - "priorities. The mapping is given in the " - "format 'from:to' where both 'from' and " - "'to' are unsigned integers, ie '7:3'.", - DBUS_TYPE_G_LIST_OF_STRING, - G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE)); + _nm_param_spec_specialized (NM_SETTING_VLAN_INGRESS_PRIORITY_MAP, "", "", + DBUS_TYPE_G_LIST_OF_STRING, + G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingVlan:egress-priority-map: * * For outgoing packets, a list of mappings from Linux SKB priorities to - * 802.1p priorities. The mapping is given in the format 'from:to' - * where both 'from' and 'to' are unsigned integers, ie '7:3'. + * 802.1p priorities. The mapping is given in the format "from:to" where + * both "from" and "to" are unsigned integers, ie "7:3". **/ g_object_class_install_property (object_class, PROP_EGRESS_PRIORITY_MAP, - _nm_param_spec_specialized (NM_SETTING_VLAN_EGRESS_PRIORITY_MAP, - "VLAN egress priority mapping", - "For outgoing packets, a list of mappings " - "from Linux SKB priorities to 802.1p " - "priorities. The mapping is given in the " - "format 'from:to' where both 'from' and " - "'to' are unsigned integers, ie '7:3'.", - DBUS_TYPE_G_LIST_OF_STRING, - G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE)); + _nm_param_spec_specialized (NM_SETTING_VLAN_EGRESS_PRIORITY_MAP, "", "", + DBUS_TYPE_G_LIST_OF_STRING, + G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); } diff --git a/libnm-util/nm-setting-vlan.h b/libnm-util/nm-setting-vlan.h index e865cd4977..ca77f6fed8 100644 --- a/libnm-util/nm-setting-vlan.h +++ b/libnm-util/nm-setting-vlan.h @@ -94,7 +94,7 @@ typedef enum { /** * NMVlanFlags: * @NM_VLAN_FLAG_REORDER_HEADERS: indicates that this interface should reorder - * outgoing packet headers to look more like a non-VLAN ethernet interface + * outgoing packet headers to look more like a non-VLAN Ethernet interface * @NM_VLAN_FLAG_GVRP: indicates that this interface should use GVRP to register * itself with it's switch * @NM_VLAN_FLAG_LOOSE_BINDING: indicates that this interface's operating diff --git a/libnm-util/nm-setting-vpn.c b/libnm-util/nm-setting-vpn.c index b5cffc14b6..5c1c30fe0f 100644 --- a/libnm-util/nm-setting-vpn.c +++ b/libnm-util/nm-setting-vpn.c @@ -816,61 +816,46 @@ nm_setting_vpn_class_init (NMSettingVPNClass *setting_class) /** * NMSettingVPN:service-type: * - * D-Bus service name of the VPN plugin that this setting uses to connect - * to its network. i.e. org.freedesktop.NetworkManager.vpnc for the vpnc + * D-Bus service name of the VPN plugin that this setting uses to connect to + * its network. i.e. org.freedesktop.NetworkManager.vpnc for the vpnc * plugin. **/ g_object_class_install_property (object_class, PROP_SERVICE_TYPE, - g_param_spec_string (NM_SETTING_VPN_SERVICE_TYPE, - "Service type", - "D-Bus service name of the VPN plugin that this " - "setting uses to connect to its network. i.e. " - "org.freedesktop.NetworkManager.vpnc for the vpnc " - "plugin.", - NULL, - G_PARAM_READWRITE)); + g_param_spec_string (NM_SETTING_VPN_SERVICE_TYPE, "", "", + NULL, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingVPN:user-name: * * If the VPN connection requires a user name for authentication, that name - * should be provided here. If the connection is available to more than - * one user, and the VPN requires each user to supply a different name, then + * should be provided here. If the connection is available to more than one + * user, and the VPN requires each user to supply a different name, then * leave this property empty. If this property is empty, NetworkManager * will automatically supply the username of the user which requested the * VPN connection. **/ g_object_class_install_property (object_class, PROP_USER_NAME, - g_param_spec_string (NM_SETTING_VPN_USER_NAME, - "User name", - "If the VPN connection requires a user name for " - "authentication, that name should be provided here. " - "If the connection is available to more than one " - "user, and the VPN requires each user to supply a " - "different name, then leave this property empty. If " - "this property is empty, NetworkManager will " - "automatically supply the username of the user which " - "requested the VPN connection.", + g_param_spec_string (NM_SETTING_VPN_USER_NAME, "", "", NULL, - G_PARAM_READWRITE)); + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingVPN:data: * - * Dictionary of key/value pairs of VPN plugin specific data. Both keys - * and values must be strings. + * Dictionary of key/value pairs of VPN plugin specific data. Both keys and + * values must be strings. **/ g_object_class_install_property (object_class, PROP_DATA, - _nm_param_spec_specialized (NM_SETTING_VPN_DATA, - "Data", - "Dictionary of key/value pairs of VPN plugin " - "specific data. Both keys and values must be " - "strings.", - DBUS_TYPE_G_MAP_OF_STRING, - G_PARAM_READWRITE)); + _nm_param_spec_specialized (NM_SETTING_VPN_DATA, "", "", + DBUS_TYPE_G_MAP_OF_STRING, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingVPN:secrets: @@ -880,12 +865,9 @@ nm_setting_vpn_class_init (NMSettingVPNClass *setting_class) **/ g_object_class_install_property (object_class, PROP_SECRETS, - _nm_param_spec_specialized (NM_SETTING_VPN_SECRETS, - "Secrets", - "Dictionary of key/value pairs of VPN plugin " - "specific secrets like passwords or private keys." - " Both keys and values must be strings.", - DBUS_TYPE_G_MAP_OF_STRING, - G_PARAM_READWRITE | NM_SETTING_PARAM_SECRET)); + _nm_param_spec_specialized (NM_SETTING_VPN_SECRETS, "", "", + DBUS_TYPE_G_MAP_OF_STRING, + G_PARAM_READWRITE | NM_SETTING_PARAM_SECRET | + G_PARAM_STATIC_STRINGS)); } diff --git a/libnm-util/nm-setting-wimax.c b/libnm-util/nm-setting-wimax.c index 60eb1c5a82..3554724d00 100644 --- a/libnm-util/nm-setting-wimax.c +++ b/libnm-util/nm-setting-wimax.c @@ -241,28 +241,22 @@ nm_setting_wimax_class_init (NMSettingWimaxClass *setting_class) **/ g_object_class_install_property (object_class, PROP_NETWORK_NAME, - g_param_spec_string (NM_SETTING_WIMAX_NETWORK_NAME, - "NetworkName", - "Network Service Provider (NSP) name of the WiMAX " - "network this connection should use.", - NULL, - G_PARAM_READWRITE)); + g_param_spec_string (NM_SETTING_WIMAX_NETWORK_NAME, "", "", + NULL, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingWimax:mac-address: * - * If specified, this connection will only apply to the WiMAX device - * whose MAC address matches. This property does not change the MAC address - * of the device (known as MAC spoofing). + * If specified, this connection will only apply to the WiMAX device whose + * MAC address matches. This property does not change the MAC address of the + * device (known as MAC spoofing). **/ g_object_class_install_property (object_class, PROP_MAC_ADDRESS, - _nm_param_spec_specialized (NM_SETTING_WIMAX_MAC_ADDRESS, - "MAC Address", - "If specified, this connection will only apply to " - "the WiMAX device whose MAC address matches. " - "This property does not change the MAC address " - "of the device (known as MAC spoofing).", - DBUS_TYPE_G_UCHAR_ARRAY, - G_PARAM_READWRITE)); + _nm_param_spec_specialized (NM_SETTING_WIMAX_MAC_ADDRESS, "", "", + DBUS_TYPE_G_UCHAR_ARRAY, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); } diff --git a/libnm-util/nm-setting-wired.c b/libnm-util/nm-setting-wired.c index 50c7e75688..e10ebeb4e7 100644 --- a/libnm-util/nm-setting-wired.c +++ b/libnm-util/nm-setting-wired.c @@ -615,7 +615,7 @@ verify (NMSetting *setting, GSList *all_settings, GError **error) g_set_error (error, NM_SETTING_WIRED_ERROR, NM_SETTING_WIRED_ERROR_INVALID_PROPERTY, - _("'%s' is not a valid ethernet port value"), + _("'%s' is not a valid Ethernet port value"), priv->port); g_prefix_error (error, "%s.%s: ", NM_SETTING_WIRED_SETTING_NAME, NM_SETTING_WIRED_PORT); return FALSE; @@ -871,88 +871,70 @@ nm_setting_wired_class_init (NMSettingWiredClass *setting_class) * NMSettingWired:port: * * Specific port type to use if multiple the device supports multiple - * attachment methods. One of 'tp' (Twisted Pair), 'aui' (Attachment Unit - * Interface), 'bnc' (Thin Ethernet) or 'mii' (Media Independent Interface. + * attachment methods. One of "tp" (Twisted Pair), "aui" (Attachment Unit + * Interface), "bnc" (Thin Ethernet) or "mii" (Media Independent Interface. * If the device supports only one port type, this setting is ignored. **/ g_object_class_install_property (object_class, PROP_PORT, - g_param_spec_string (NM_SETTING_WIRED_PORT, - "Port", - "Specific port type to use if multiple the device " - "supports multiple attachment methods. One of " - "'tp' (Twisted Pair), 'aui' (Attachment Unit Interface), " - "'bnc' (Thin Ethernet) or 'mii' (Media Independent " - "Interface. If the device supports only one port " - "type, this setting is ignored.", - NULL, - G_PARAM_READWRITE)); + g_param_spec_string (NM_SETTING_WIRED_PORT, "", "", + NULL, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingWired:speed: * - * If non-zero, request that the device use only the specified speed. - * In Mbit/s, ie 100 == 100Mbit/s. + * If non-zero, request that the device use only the specified speed. In + * Mbit/s, ie 100 == 100Mbit/s. **/ g_object_class_install_property (object_class, PROP_SPEED, - g_param_spec_uint (NM_SETTING_WIRED_SPEED, - "Speed", - "If non-zero, request that the device use only the " - "specified speed. In Mbit/s, ie 100 == 100Mbit/s.", - 0, G_MAXUINT32, 0, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + g_param_spec_uint (NM_SETTING_WIRED_SPEED, "", "", + 0, G_MAXUINT32, 0, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); /** * NMSettingWired:duplex: * * If specified, request that the device only use the specified duplex mode. - * Either 'half' or 'full'. + * Either "half" or "full". **/ g_object_class_install_property (object_class, PROP_DUPLEX, - g_param_spec_string (NM_SETTING_WIRED_DUPLEX, - "Duplex", - "If specified, request that the device only use the " - "specified duplex mode. Either 'half' or 'full'.", - NULL, - G_PARAM_READWRITE)); + g_param_spec_string (NM_SETTING_WIRED_DUPLEX, "", "", + NULL, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** - * NMSettingEthernet:auto-negotiate: + * NMSettingWired:auto-negotiate: * - * If TRUE, allow auto-negotiation of port speed and duplex mode. If FALSE, - * do not allow auto-negotiation, in which case the 'speed' and 'duplex' - * properties should be set. + * If %TRUE, allow auto-negotiation of port speed and duplex mode. If + * %FALSE, do not allow auto-negotiation, in which case the "speed" and + * "duplex" properties should be set. **/ g_object_class_install_property (object_class, PROP_AUTO_NEGOTIATE, - g_param_spec_boolean (NM_SETTING_WIRED_AUTO_NEGOTIATE, - "AutoNegotiate", - "If TRUE, allow auto-negotiation of port speed and " - "duplex mode. If FALSE, do not allow auto-negotiation," - "in which case the 'speed' and 'duplex' properties " - "should be set.", - TRUE, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + g_param_spec_boolean (NM_SETTING_WIRED_AUTO_NEGOTIATE, "", "", + TRUE, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); /** * NMSettingWired:mac-address: * - * If specified, this connection will only apply to the ethernet device - * whose permanent MAC address matches. This property does not change the MAC address - * of the device (i.e. MAC spoofing). + * If specified, this connection will only apply to the Ethernet device + * whose permanent MAC address matches. This property does not change the + * MAC address of the device (i.e. MAC spoofing). **/ g_object_class_install_property (object_class, PROP_MAC_ADDRESS, - _nm_param_spec_specialized (NM_SETTING_WIRED_MAC_ADDRESS, - "Device MAC Address", - "If specified, this connection will only apply to " - "the ethernet device whose permanent MAC address matches. " - "This property does not change the MAC address " - "of the device (i.e. MAC spoofing).", - DBUS_TYPE_G_UCHAR_ARRAY, - G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE)); + _nm_param_spec_specialized (NM_SETTING_WIRED_MAC_ADDRESS, "", "", + DBUS_TYPE_G_UCHAR_ARRAY, + G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingWired:cloned-mac-address: @@ -962,32 +944,25 @@ nm_setting_wired_class_init (NMSettingWiredClass *setting_class) **/ g_object_class_install_property (object_class, PROP_CLONED_MAC_ADDRESS, - _nm_param_spec_specialized (NM_SETTING_WIRED_CLONED_MAC_ADDRESS, - "Cloned MAC Address", - "If specified, request that the device use " - "this MAC address instead of its permanent MAC address. " - "This is known as MAC cloning or spoofing.", - DBUS_TYPE_G_UCHAR_ARRAY, - G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE)); + _nm_param_spec_specialized (NM_SETTING_WIRED_CLONED_MAC_ADDRESS, "", "", + DBUS_TYPE_G_UCHAR_ARRAY, + G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingWired:mac-address-blacklist: * - * If specified, this connection will never apply to the ethernet device - * whose permanent MAC address matches an address in the list. Each - * MAC address is in the standard hex-digits-and-colons notation + * If specified, this connection will never apply to the Ethernet device + * whose permanent MAC address matches an address in the list. Each MAC + * address is in the standard hex-digits-and-colons notation * (00:11:22:33:44:55). **/ g_object_class_install_property (object_class, PROP_MAC_ADDRESS_BLACKLIST, - _nm_param_spec_specialized (NM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST, - "MAC Address Blacklist", - "If specified, this connection will never apply to " - "the ethernet device whose permanent MAC address matches " - "an address in the list. Each MAC address is in the " - "standard hex-digits-and-colons notation (00:11:22:33:44:55).", + _nm_param_spec_specialized (NM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST, "", "", DBUS_TYPE_G_LIST_OF_STRING, - G_PARAM_READWRITE | NM_SETTING_PARAM_FUZZY_IGNORE)); + G_PARAM_READWRITE | NM_SETTING_PARAM_FUZZY_IGNORE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingWired:mtu: @@ -997,73 +972,55 @@ nm_setting_wired_class_init (NMSettingWiredClass *setting_class) **/ g_object_class_install_property (object_class, PROP_MTU, - g_param_spec_uint (NM_SETTING_WIRED_MTU, - "MTU", - "If non-zero, only transmit packets of the specified " - "size or smaller, breaking larger packets up into " - "multiple Ethernet frames.", - 0, G_MAXUINT32, 0, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_FUZZY_IGNORE)); + g_param_spec_uint (NM_SETTING_WIRED_MTU, "", "", + 0, G_MAXUINT32, 0, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_FUZZY_IGNORE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingWired:s390-subchannels: * * Identifies specific subchannels that this network device uses for - * communcation with z/VM or s390 host. Like #NMSettingWired:mac-address - * for non-z/VM devices, this property can be used to ensure this connection - * only applies to the network device that uses these subchannels. The - * list should contain exactly 3 strings, and each string may only be - * composed of hexadecimal characters and the period (.) character. + * communication with z/VM or s390 host. Like the + * #NMSettingWired:mac-address property for non-z/VM devices, this property + * can be used to ensure this connection only applies to the network device + * that uses these subchannels. The list should contain exactly 3 strings, + * and each string may only be composed of hexadecimal characters and the + * period (.) character. **/ g_object_class_install_property (object_class, PROP_S390_SUBCHANNELS, - _nm_param_spec_specialized (NM_SETTING_WIRED_S390_SUBCHANNELS, - "z/VM Subchannels", - "Identifies specific subchannels that this " - "network device uses for communcation with z/VM " - "or s390 host. Like the 'mac-address' property " - "for non-z/VM devices, this property can be used " - "to ensure this connection only applies to the " - "network device that uses these subchannels. The " - "list should contain exactly 3 strings, and each " - "string may only be composed of hexadecimal " - "characters and the period (.) character.", - DBUS_TYPE_G_ARRAY_OF_STRING, - G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE)); + _nm_param_spec_specialized (NM_SETTING_WIRED_S390_SUBCHANNELS, "", "", + DBUS_TYPE_G_ARRAY_OF_STRING, + G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingWired:s390-nettype: * - * s390 network device type; one of 'qeth', 'lcs', or 'ctc', representing + * s390 network device type; one of "qeth", "lcs", or "ctc", representing * the different types of virtual network devices available on s390 systems. **/ g_object_class_install_property (object_class, PROP_S390_NETTYPE, - g_param_spec_string (NM_SETTING_WIRED_S390_NETTYPE, - "s390 Net Type", - "s390 network device type; one of 'qeth', 'lcs', or " - "'ctc', representing the different types of virtual " - "network devices available on s390 systems.", - NULL, - G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE)); + g_param_spec_string (NM_SETTING_WIRED_S390_NETTYPE, "", "", + NULL, + G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingWired:s390-options: * * Dictionary of key/value pairs of s390-specific device options. Both keys - * and values must be strings. Allowed keys include 'portno', 'layer2', - * 'portname', 'protocol', among others. Key names must contain only + * and values must be strings. Allowed keys include "portno", "layer2", + * "portname", "protocol", among others. Key names must contain only * alphanumeric characters (ie, [a-zA-Z0-9]). **/ g_object_class_install_property (object_class, PROP_S390_OPTIONS, - _nm_param_spec_specialized (NM_SETTING_WIRED_S390_OPTIONS, - "s390 Options", - "Dictionary of key/value pairs of s390-specific " - "device options. Both keys and values must be " - "strings. Allowed keys include 'portno', " - "'layer2', 'portname', 'protocol', among others.", - DBUS_TYPE_G_MAP_OF_STRING, - G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE)); + _nm_param_spec_specialized (NM_SETTING_WIRED_S390_OPTIONS, "", "", + DBUS_TYPE_G_MAP_OF_STRING, + G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE | + G_PARAM_STATIC_STRINGS)); } diff --git a/libnm-util/nm-setting-wireless-security.c b/libnm-util/nm-setting-wireless-security.c index 29c9150767..fad6c8e72b 100644 --- a/libnm-util/nm-setting-wireless-security.c +++ b/libnm-util/nm-setting-wireless-security.c @@ -38,17 +38,17 @@ /** * SECTION:nm-setting-wireless-security - * @short_description: Describes connection properties for WiFi networks that + * @short_description: Describes connection properties for Wi-Fi networks that * use WEP, LEAP, WPA or WPA2/RSN security * @include: nm-setting-wireless-security.h * * The #NMSettingWirelessSecurity object is a #NMSetting subclass that describes - * properties necessary for connection to encrypted WiFi networks. + * properties necessary for connection to encrypted Wi-Fi networks. * * It's a good idea to read up on wpa_supplicant configuration before using this * setting extensively, since most of the options here correspond closely with * the relevant wpa_supplicant configuration options. To get a better overview - * of how WiFi security works, you may want to get copies of the following books. + * of how Wi-Fi security works, you may want to get copies of the following books. * * 802.11 Wireless Networks: The Definitive Guide, Second Edition * Author: Matthew Gast @@ -167,7 +167,7 @@ nm_setting_wireless_security_get_key_mgmt (NMSettingWirelessSecurity *setting) * @setting: the #NMSettingWirelessSecurity * * Returns: the number of security protocols this connection allows when - * connecting to secure WiFi networks + * connecting to secure Wi-Fi networks **/ guint32 nm_setting_wireless_security_get_num_protos (NMSettingWirelessSecurity *setting) @@ -202,9 +202,9 @@ nm_setting_wireless_security_get_proto (NMSettingWirelessSecurity *setting, guin * @setting: the #NMSettingWirelessSecurity * @proto: the protocol to add, one of "wpa" or "rsn" * - * Adds a WiFi security protocol (one of "wpa" or "rsn") to the allowed list; + * Adds a Wi-Fi security protocol (one of "wpa" or "rsn") to the allowed list; * only protocols in this list will be used when finding and connecting to - * the WiFi network specified by this connection. For example, if the + * the Wi-Fi network specified by this connection. For example, if the * protocol list contains only "wpa" but the access point for the SSID specified * by this connection only supports WPA2/RSN, the connection cannot be used * with the access point. @@ -1348,105 +1348,77 @@ nm_setting_wireless_security_class_init (NMSettingWirelessSecurityClass *setting /** * NMSettingWirelessSecurity:key-mgmt: * - * Key management used for the connection. One of 'none' (WEP), 'ieee8021x' - * (Dynamic WEP), 'wpa-none' (Ad-Hoc WPA-PSK), 'wpa-psk' (infrastructure - * WPA-PSK), or 'wpa-eap' (WPA-Enterprise). This property must be set for - * any WiFi connection that uses security. + * Key management used for the connection. One of "none" (WEP), "ieee8021x" + * (Dynamic WEP), "wpa-none" (Ad-Hoc WPA-PSK), "wpa-psk" (infrastructure + * WPA-PSK), or "wpa-eap" (WPA-Enterprise). This property must be set for + * any Wi-Fi connection that uses security. **/ g_object_class_install_property (object_class, PROP_KEY_MGMT, - g_param_spec_string (NM_SETTING_WIRELESS_SECURITY_KEY_MGMT, - "Key management", - "Key management used for the connection. One of " - "'none' (WEP), 'ieee8021x' (Dynamic WEP), 'wpa-none' " - "(WPA-PSK Ad-Hoc), 'wpa-psk' (infrastructure WPA-PSK), " - "or 'wpa-eap' (WPA-Enterprise). This property must " - "be set for any WiFi connection that uses security.", - NULL, - G_PARAM_READWRITE | NM_SETTING_PARAM_REQUIRED)); + g_param_spec_string (NM_SETTING_WIRELESS_SECURITY_KEY_MGMT, "", "", + NULL, + G_PARAM_READWRITE | NM_SETTING_PARAM_REQUIRED | + G_PARAM_STATIC_STRINGS)); /** * NMSettingWirelessSecurity:wep-tx-keyidx: * - * When static WEP is used (ie, key-mgmt = 'none') and a non-default WEP key + * When static WEP is used (ie, key-mgmt = "none") and a non-default WEP key * index is used by the AP, put that WEP key index here. Valid values are 0 * (default key) through 3. Note that some consumer access points (like the * Linksys WRT54G) number the keys 1 - 4. **/ g_object_class_install_property (object_class, PROP_WEP_TX_KEYIDX, - g_param_spec_uint (NM_SETTING_WIRELESS_SECURITY_WEP_TX_KEYIDX, - "WEP TX key index", - "When static WEP is used (ie, key-mgmt = 'none') and a " - "non-default WEP key index is used by the AP, put that " - "WEP key index here. Valid values are 0 (default key) " - "through 3. Note that some consumer access points " - "(like the Linksys WRT54G) number the keys 1 - 4.", - 0, 3, 0, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + g_param_spec_uint (NM_SETTING_WIRELESS_SECURITY_WEP_TX_KEYIDX, "", "", + 0, 3, 0, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); /** * NMSettingWirelessSecurity:auth-alg: * - * When WEP is used (ie, key-mgmt = 'none' or 'ieee8021x') indicate the - * 802.11 authentication algorithm required by the AP here. One of 'open' - * for Open System, 'shared' for Shared Key, or 'leap' for Cisco LEAP. - * When using Cisco LEAP (ie, key-mgmt = 'ieee8021x' and auth-alg = 'leap') - * the 'leap-username' and 'leap-password' properties must be specified. + * When WEP is used (ie, key-mgmt = "none" or "ieee8021x") indicate the + * 802.11 authentication algorithm required by the AP here. One of "open" + * for Open System, "shared" for Shared Key, or "leap" for Cisco LEAP. When + * using Cisco LEAP (ie, key-mgmt = "ieee8021x" and auth-alg = "leap") the + * "leap-username" and "leap-password" properties must be specified. **/ g_object_class_install_property (object_class, PROP_AUTH_ALG, - g_param_spec_string (NM_SETTING_WIRELESS_SECURITY_AUTH_ALG, - "AuthAlg", - "When WEP is used (ie, key-mgmt = 'none' or " - "'ieee8021x') indicate the 802.11 authentication " - "algorithm required by the AP here. One of 'open' for " - "Open System, 'shared' for Shared Key, or 'leap' for " - "Cisco LEAP. When using Cisco LEAP (ie, key-mgmt = " - "'ieee8021x' and auth-alg = 'leap') the 'leap-username' " - "and 'leap-password' properties must be specified.", - NULL, - G_PARAM_READWRITE)); + g_param_spec_string (NM_SETTING_WIRELESS_SECURITY_AUTH_ALG, "", "", + NULL, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingWirelessSecurity:proto: * * List of strings specifying the allowed WPA protocol versions to use. - * Each element may be one 'wpa' (allow WPA) or 'rsn' (allow WPA2/RSN). If + * Each element may be one "wpa" (allow WPA) or "rsn" (allow WPA2/RSN). If * not specified, both WPA and RSN connections are allowed. **/ g_object_class_install_property (object_class, PROP_PROTO, - _nm_param_spec_specialized (NM_SETTING_WIRELESS_SECURITY_PROTO, - "Proto", - "List of strings specifying the allowed WPA " - "protocol versions to use. Each element may be " - "one 'wpa' (allow WPA) or 'rsn' (allow " - "WPA2/RSN). If not specified, both WPA and RSN " - "connections are allowed.", - DBUS_TYPE_G_LIST_OF_STRING, - G_PARAM_READWRITE)); + _nm_param_spec_specialized (NM_SETTING_WIRELESS_SECURITY_PROTO, "", "", + DBUS_TYPE_G_LIST_OF_STRING, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingWirelessSecurity:pairwise: * * A list of pairwise encryption algorithms which prevents connections to - * Wi-Fi networks that do not utilize one of the algorithms in the list. For - * maximum compatibility leave this property empty. Each list element may - * be one of 'tkip' or 'ccmp'. + * Wi-Fi networks that do not utilize one of the algorithms in the list. + * For maximum compatibility leave this property empty. Each list element + * may be one of "tkip" or "ccmp". **/ g_object_class_install_property (object_class, PROP_PAIRWISE, - _nm_param_spec_specialized (NM_SETTING_WIRELESS_SECURITY_PAIRWISE, - "Pairwise", - "A list of pairwise encryption algorithms which " - "prevents connections to Wi-Fi networks that do " - "not utilize one of the algorithms in the list. " - "For maximum compatibility leave this property " - "empty. Each list element may be one of 'tkip' " - "or 'ccmp'.", - DBUS_TYPE_G_LIST_OF_STRING, - G_PARAM_READWRITE)); + _nm_param_spec_specialized (NM_SETTING_WIRELESS_SECURITY_PAIRWISE, "", "", + DBUS_TYPE_G_LIST_OF_STRING, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingWirelessSecurity:group: @@ -1454,113 +1426,95 @@ nm_setting_wireless_security_class_init (NMSettingWirelessSecurityClass *setting * A list of group/broadcast encryption algorithms which prevents * connections to Wi-Fi networks that do not utilize one of the algorithms * in the list. For maximum compatibility leave this property empty. Each - * list element may be one of 'wep40', 'wep104', 'tkip', or 'ccmp'. + * list element may be one of "wep40", "wep104", "tkip", or "ccmp". **/ g_object_class_install_property (object_class, PROP_GROUP, - _nm_param_spec_specialized (NM_SETTING_WIRELESS_SECURITY_GROUP, - "Group", - "A list of group/broadcast encryption algorithms " - "which prevents connections to Wi-Fi networks " - "that do not utilize one of the algorithms in " - "the list. For maximum compatibility leave this " - "property empty. Each list element may be one " - " of 'wep40', 'wep104', 'tkip', or 'ccmp'.", - DBUS_TYPE_G_LIST_OF_STRING, - G_PARAM_READWRITE)); + _nm_param_spec_specialized (NM_SETTING_WIRELESS_SECURITY_GROUP, "", "", + DBUS_TYPE_G_LIST_OF_STRING, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingWirelessSecurity:leap-username: * * The login username for legacy LEAP connections (ie, key-mgmt = - * 'ieee8021x' and auth-alg = 'leap'). + * "ieee8021x" and auth-alg = "leap"). **/ g_object_class_install_property (object_class, PROP_LEAP_USERNAME, - g_param_spec_string (NM_SETTING_WIRELESS_SECURITY_LEAP_USERNAME, - "LEAP Username", - "The login username for legacy LEAP connections " - "(ie, key-mgmt = 'ieee8021x' and auth-alg = 'leap').", - NULL, - G_PARAM_READWRITE)); + g_param_spec_string (NM_SETTING_WIRELESS_SECURITY_LEAP_USERNAME, "", "", + NULL, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingWirelessSecurity:wep-key0: * * Index 0 WEP key. This is the WEP key used in most networks. See the - * 'wep-key-type' property for a description of how this key is interpreted. + * "wep-key-type" property for a description of how this key is interpreted. **/ g_object_class_install_property (object_class, PROP_WEP_KEY0, - g_param_spec_string (NM_SETTING_WIRELESS_SECURITY_WEP_KEY0, - "WEP key0", - "Index 0 WEP key. This is the WEP key used in most " - "networks. See the 'wep-key-type' property for a " - "description of how this key is interpreted.", - NULL, - G_PARAM_READWRITE | NM_SETTING_PARAM_SECRET)); + g_param_spec_string (NM_SETTING_WIRELESS_SECURITY_WEP_KEY0, "", "", + NULL, + G_PARAM_READWRITE | NM_SETTING_PARAM_SECRET | + G_PARAM_STATIC_STRINGS)); /** * NMSettingWirelessSecurity:wep-key1: * * Index 1 WEP key. This WEP index is not used by most networks. See the - * 'wep-key-type' property for a description of how this key is interpreted. + * "wep-key-type" property for a description of how this key is interpreted. **/ g_object_class_install_property (object_class, PROP_WEP_KEY1, - g_param_spec_string (NM_SETTING_WIRELESS_SECURITY_WEP_KEY1, - "WEP key1", - "Index 1 WEP key. This WEP index is not used by most " - "networks. See the 'wep-key-type' property for a " - "description of how this key is interpreted.", - NULL, - G_PARAM_READWRITE | NM_SETTING_PARAM_SECRET)); + g_param_spec_string (NM_SETTING_WIRELESS_SECURITY_WEP_KEY1, "", "", + NULL, + G_PARAM_READWRITE | NM_SETTING_PARAM_SECRET | + G_PARAM_STATIC_STRINGS)); /** * NMSettingWirelessSecurity:wep-key2: * * Index 2 WEP key. This WEP index is not used by most networks. See the - * 'wep-key-type' property for a description of how this key is interpreted. + * "wep-key-type" property for a description of how this key is interpreted. **/ g_object_class_install_property (object_class, PROP_WEP_KEY2, - g_param_spec_string (NM_SETTING_WIRELESS_SECURITY_WEP_KEY2, - "WEP key2", - "Index 2 WEP key. This WEP index is not used by most " - "networks. See the 'wep-key-type' property for a " - "description of how this key is interpreted.", - NULL, - G_PARAM_READWRITE | NM_SETTING_PARAM_SECRET)); + g_param_spec_string (NM_SETTING_WIRELESS_SECURITY_WEP_KEY2, "", "", + NULL, + G_PARAM_READWRITE | NM_SETTING_PARAM_SECRET | + G_PARAM_STATIC_STRINGS)); /** * NMSettingWirelessSecurity:wep-key3: * * Index 3 WEP key. This WEP index is not used by most networks. See the - * 'wep-key-type' property for a description of how this key is interpreted. + * "wep-key-type" property for a description of how this key is interpreted. **/ g_object_class_install_property (object_class, PROP_WEP_KEY3, - g_param_spec_string (NM_SETTING_WIRELESS_SECURITY_WEP_KEY3, - "WEP key3", - "Index 3 WEP key. This WEP index is not used by most " - "networks. See the 'wep-key-type' property for a " - "description of how this key is interpreted.", - NULL, - G_PARAM_READWRITE | NM_SETTING_PARAM_SECRET)); + g_param_spec_string (NM_SETTING_WIRELESS_SECURITY_WEP_KEY3, "", "", + NULL, + G_PARAM_READWRITE | NM_SETTING_PARAM_SECRET | + G_PARAM_STATIC_STRINGS)); /** * NMSettingWirelessSecurity:wep-key-flags: * - * Flags indicating how to handle #NMSettingWirelessSecurity WEP keys. + * Flags indicating how to handle the #NMSettingWirelessSecurity:wep-key0, + * #NMSettingWirelessSecurity:wep-key1, #NMSettingWirelessSecurity:wep-key2, + * and #NMSettingWirelessSecurity:wep-key3 properties. **/ - g_object_class_install_property (object_class, PROP_WEP_KEY_FLAGS, - g_param_spec_uint (NM_SETTING_WIRELESS_SECURITY_WEP_KEY_FLAGS, - "WEP Key Flags", - "Flags indicating how to handle the WEP keys.", + g_object_class_install_property + (object_class, PROP_WEP_KEY_FLAGS, + g_param_spec_uint (NM_SETTING_WIRELESS_SECURITY_WEP_KEY_FLAGS, "", "", NM_SETTING_SECRET_FLAG_NONE, NM_SETTING_SECRET_FLAGS_ALL, NM_SETTING_SECRET_FLAG_NONE, - G_PARAM_READWRITE)); + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingWirelessSecurity:psk: @@ -1568,92 +1522,76 @@ nm_setting_wireless_security_class_init (NMSettingWirelessSecurityClass *setting * Pre-Shared-Key for WPA networks. If the key is 64-characters long, it * must contain only hexadecimal characters and is interpreted as a * hexadecimal WPA key. Otherwise, the key must be between 8 and 63 ASCII - * characters (as specified in the 802.11i standard) and is interpreted as - * a WPA passphrase, and is hashed to derive the actual WPA-PSK used when - * connecting to the WiFi network. + * characters (as specified in the 802.11i standard) and is interpreted as a + * WPA passphrase, and is hashed to derive the actual WPA-PSK used when + * connecting to the Wi-Fi network. **/ g_object_class_install_property (object_class, PROP_PSK, - g_param_spec_string (NM_SETTING_WIRELESS_SECURITY_PSK, - "PSK", - "Pre-Shared-Key for WPA networks. If the key is " - "64-characters long, it must contain only hexadecimal " - "characters and is interpreted as a hexadecimal WPA " - "key. Otherwise, the key must be between 8 and 63 " - "ASCII characters (as specified in the 802.11i standard) " - "and is interpreted as a WPA passphrase, and is hashed " - "to derive the actual WPA-PSK used when connecting to " - "the WiFi network.", - NULL, - G_PARAM_READWRITE | NM_SETTING_PARAM_SECRET)); + g_param_spec_string (NM_SETTING_WIRELESS_SECURITY_PSK, "", "", + NULL, + G_PARAM_READWRITE | NM_SETTING_PARAM_SECRET | + G_PARAM_STATIC_STRINGS)); /** * NMSettingWirelessSecurity:psk-flags: * - * Flags indicating how to handle #NMSettingWirelessSecurity:psk + * Flags indicating how to handle the #NMSettingWirelessSecurity:psk + * property. **/ - g_object_class_install_property (object_class, PROP_PSK_FLAGS, - g_param_spec_uint (NM_SETTING_WIRELESS_SECURITY_PSK_FLAGS, - "PSK Flags", - "Flags indicating how to handle the WPA PSK key.", + g_object_class_install_property + (object_class, PROP_PSK_FLAGS, + g_param_spec_uint (NM_SETTING_WIRELESS_SECURITY_PSK_FLAGS, "", "", NM_SETTING_SECRET_FLAG_NONE, NM_SETTING_SECRET_FLAGS_ALL, NM_SETTING_SECRET_FLAG_NONE, - G_PARAM_READWRITE)); + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingWirelessSecurity:leap-password: * * The login password for legacy LEAP connections (ie, key-mgmt = - * 'ieee8021x' and auth-alg = 'leap'). + * "ieee8021x" and auth-alg = "leap"). **/ g_object_class_install_property (object_class, PROP_LEAP_PASSWORD, - g_param_spec_string (NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD, - "LEAP Password", - "The login password for legacy LEAP connections " - "(ie, key-mgmt = 'ieee8021x' and auth-alg = 'leap').", - NULL, - G_PARAM_READWRITE | NM_SETTING_PARAM_SECRET)); + g_param_spec_string (NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD, "", "", + NULL, + G_PARAM_READWRITE | NM_SETTING_PARAM_SECRET | + G_PARAM_STATIC_STRINGS)); /** * NMSettingWirelessSecurity:leap-password-flags: * - * Flags indicating how to handle #NMSettingWirelessSecurity:leap-password. + * Flags indicating how to handle the + * #NMSettingWirelessSecurity:leap-password property. **/ - g_object_class_install_property (object_class, PROP_LEAP_PASSWORD_FLAGS, - g_param_spec_uint (NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD_FLAGS, - "LEAP Password Flags", - "Flags indicating how to handle the LEAP password.", + g_object_class_install_property + (object_class, PROP_LEAP_PASSWORD_FLAGS, + g_param_spec_uint (NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD_FLAGS, "", "", NM_SETTING_SECRET_FLAG_NONE, NM_SETTING_SECRET_FLAGS_ALL, NM_SETTING_SECRET_FLAG_NONE, - G_PARAM_READWRITE)); + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingWirelessSecurity:wep-key-type: * - * Controls the interpretation of WEP keys. Allowed values are those given - * by %NMWepKeyType. If set to 1 and the keys are hexadecimal, they must be - * either 10 or 26 characters in length. If set to 1 and the keys are - * ASCII keys, they must be either 5 or 13 characters in length. If set to - * 2, the passphrase is hashed using the de-facto MD5 method to derive the - * actual WEP key. + * Controls the interpretation of WEP keys. Allowed values are + * %NM_WEP_KEY_TYPE_KEY, in which case the key is either a 10- or + * 26-character hexadecimal string, or a 5- or 13-character ASCII password; + * or %NM_WEP_KEY_TYPE_PASSPHRASE, in which case the passphrase is provided + * as a string and will be hashed using the de-facto MD5 method to derive + * the actual WEP key. **/ g_object_class_install_property (object_class, PROP_WEP_KEY_TYPE, - g_param_spec_uint (NM_SETTING_WIRELESS_SECURITY_WEP_KEY_TYPE, - "WEP Key Type", - "Controls the interpretation of WEP keys. Allowed values " - "are 1 (interpret WEP keys as hexadecimal or ASCII keys) " - "or 2 (interpret WEP keys as WEP Passphrases). If set to " - "1 and the keys are hexadecimal, they must be either 10 or " - "26 characters in length. If set to 1 and the keys are " - "ASCII keys, they must be either 5 or 13 characters in " - "length. If set to 2, the passphrase is hashed using " - " the de-facto MD5 method to derive the actual WEP key.", - NM_WEP_KEY_TYPE_UNKNOWN, - NM_WEP_KEY_TYPE_LAST, - NM_WEP_KEY_TYPE_UNKNOWN, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + g_param_spec_uint (NM_SETTING_WIRELESS_SECURITY_WEP_KEY_TYPE, "", "", + NM_WEP_KEY_TYPE_UNKNOWN, + NM_WEP_KEY_TYPE_LAST, + NM_WEP_KEY_TYPE_UNKNOWN, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); } diff --git a/libnm-util/nm-setting-wireless.c b/libnm-util/nm-setting-wireless.c index c350625ae4..1769339d23 100644 --- a/libnm-util/nm-setting-wireless.c +++ b/libnm-util/nm-setting-wireless.c @@ -39,11 +39,11 @@ /** * SECTION:nm-setting-wireless - * @short_description: Describes connection properties for 802.11 WiFi networks + * @short_description: Describes connection properties for 802.11 Wi-Fi networks * @include: nm-setting-wireless.h * * The #NMSettingWireless object is a #NMSetting subclass that describes properties - * necessary for connection to 802.11 WiFi networks. + * necessary for connection to 802.11 Wi-Fi networks. **/ /** @@ -1033,75 +1033,59 @@ nm_setting_wireless_class_init (NMSettingWirelessClass *setting_class) /** * NMSettingWireless:ssid: * - * SSID of the WiFi network. + * SSID of the Wi-Fi network. Must be specified. **/ g_object_class_install_property (object_class, PROP_SSID, - _nm_param_spec_specialized (NM_SETTING_WIRELESS_SSID, - "SSID", - "SSID of the WiFi network. Must be specified.", - DBUS_TYPE_G_UCHAR_ARRAY, - G_PARAM_READWRITE)); + _nm_param_spec_specialized (NM_SETTING_WIRELESS_SSID, "", "", + DBUS_TYPE_G_UCHAR_ARRAY, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingWireless:mode: * - * WiFi network mode; one of 'infrastructure', 'adhoc' or 'ap'. If blank, + * Wi-Fi network mode; one of "infrastructure", "adhoc" or "ap". If blank, * infrastructure is assumed. **/ g_object_class_install_property (object_class, PROP_MODE, - g_param_spec_string (NM_SETTING_WIRELESS_MODE, - "Mode", - "WiFi network mode; one of 'infrastructure', " - "'adhoc' or 'ap'. If blank, infrastructure is assumed.", - NULL, - G_PARAM_READWRITE)); + g_param_spec_string (NM_SETTING_WIRELESS_MODE, "", "", + NULL, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingWireless:band: * - * 802.11 frequency band of the network. One of 'a' for 5GHz 802.11a or - * 'bg' for 2.4GHz 802.11. This will lock associations to the WiFi network - * to the specific band, i.e. if 'a' is specified, the device will not + * 802.11 frequency band of the network. One of "a" for 5GHz 802.11a or + * "bg" for 2.4GHz 802.11. This will lock associations to the Wi-Fi network + * to the specific band, i.e. if "a" is specified, the device will not * associate with the same network in the 2.4GHz band even if the network's * settings are compatible. This setting depends on specific driver * capability and may not work with all drivers. **/ g_object_class_install_property (object_class, PROP_BAND, - g_param_spec_string (NM_SETTING_WIRELESS_BAND, - "Band", - "802.11 frequency band of the network. One of 'a' " - "for 5GHz 802.11a or 'bg' for 2.4GHz 802.11. This " - "will lock associations to the WiFi network to the " - "specific band, i.e. if 'a' is specified, the device " - "will not associate with the same network in the " - "2.4GHz band even if the network's settings are " - "compatible. This setting depends on specific driver " - "capability and may not work with all drivers.", - NULL, - G_PARAM_READWRITE)); + g_param_spec_string (NM_SETTING_WIRELESS_BAND, "", "", + NULL, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingWireless:channel: * - * Wireless channel to use for the WiFi connection. The device will only - * join (or create for Ad-Hoc networks) a WiFi network on the specified + * Wireless channel to use for the Wi-Fi connection. The device will only + * join (or create for Ad-Hoc networks) a Wi-Fi network on the specified * channel. Because channel numbers overlap between bands, this property - * also requires the 'band' property to be set. + * also requires the "band" property to be set. **/ g_object_class_install_property (object_class, PROP_CHANNEL, - g_param_spec_uint (NM_SETTING_WIRELESS_CHANNEL, - "Channel", - "Wireless channel to use for the WiFi connection. The " - "device will only join (or create for Ad-Hoc networks) " - "a WiFi network on the specified channel. Because " - "channel numbers overlap between bands, this property " - "also requires the 'band' property to be set.", - 0, G_MAXUINT32, 0, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + g_param_spec_uint (NM_SETTING_WIRELESS_CHANNEL, "", "", + 0, G_MAXUINT32, 0, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | + G_PARAM_STATIC_STRINGS)); /** * NMSettingWireless:bssid: @@ -1113,16 +1097,10 @@ nm_setting_wireless_class_init (NMSettingWirelessClass *setting_class) **/ g_object_class_install_property (object_class, PROP_BSSID, - _nm_param_spec_specialized (NM_SETTING_WIRELESS_BSSID, - "BSSID", - "If specified, directs the device to only associate " - "with the given access point. This capability is " - "highly driver dependent and not supported by all " - "devices. Note: this property does not control " - "the BSSID used when creating an Ad-Hoc network " - "and is unlikely to in the future.", - DBUS_TYPE_G_UCHAR_ARRAY, - G_PARAM_READWRITE)); + _nm_param_spec_specialized (NM_SETTING_WIRELESS_BSSID, "", "", + DBUS_TYPE_G_UCHAR_ARRAY, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingWireless:rate: @@ -1134,15 +1112,10 @@ nm_setting_wireless_class_init (NMSettingWirelessClass *setting_class) **/ g_object_class_install_property (object_class, PROP_RATE, - g_param_spec_uint (NM_SETTING_WIRELESS_RATE, - "Rate", - "If non-zero, directs the device to only use the " - "specified bitrate for communication with the access " - "point. Units are in Kb/s, ie 5500 = 5.5 Mbit/s. This " - "property is highly driver dependent and not all devices " - "support setting a static bitrate.", - 0, G_MAXUINT32, 0, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_FUZZY_IGNORE)); + g_param_spec_uint (NM_SETTING_WIRELESS_RATE, "", "", + 0, G_MAXUINT32, 0, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_FUZZY_IGNORE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingWireless:tx-power: @@ -1153,91 +1126,68 @@ nm_setting_wireless_class_init (NMSettingWirelessClass *setting_class) **/ g_object_class_install_property (object_class, PROP_TX_POWER, - g_param_spec_uint (NM_SETTING_WIRELESS_TX_POWER, - "TX Power", - "If non-zero, directs the device to use the specified " - "transmit power. Units are dBm. This property is highly " - "driver dependent and not all devices support setting a " - "static transmit power.", - 0, G_MAXUINT32, 0, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_FUZZY_IGNORE)); + g_param_spec_uint (NM_SETTING_WIRELESS_TX_POWER, "", "", + 0, G_MAXUINT32, 0, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_FUZZY_IGNORE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingWireless:mac-address: * - * If specified, this connection will only apply to the WiFi device - * whose permanent MAC address matches. This property does not change the MAC address - * of the device (i.e. MAC spoofing). + * If specified, this connection will only apply to the Wi-Fi device whose + * permanent MAC address matches. This property does not change the MAC + * address of the device (i.e. MAC spoofing). **/ g_object_class_install_property (object_class, PROP_MAC_ADDRESS, - _nm_param_spec_specialized (NM_SETTING_WIRELESS_MAC_ADDRESS, - "Device MAC Address", - "If specified, this connection will only apply to " - "the WiFi device whose permanent MAC address matches. " - "This property does not change the MAC address " - "of the device (i.e. MAC spoofing).", - DBUS_TYPE_G_UCHAR_ARRAY, - G_PARAM_READWRITE)); + _nm_param_spec_specialized (NM_SETTING_WIRELESS_MAC_ADDRESS, "", "", + DBUS_TYPE_G_UCHAR_ARRAY, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingWireless:cloned-mac-address: * - * If specified, request that the Wifi device use this MAC address instead of its - * permanent MAC address. This is known as MAC cloning or spoofing. + * If specified, request that the Wi-Fi device use this MAC address instead + * of its permanent MAC address. This is known as MAC cloning or spoofing. **/ g_object_class_install_property (object_class, PROP_CLONED_MAC_ADDRESS, - _nm_param_spec_specialized (NM_SETTING_WIRELESS_CLONED_MAC_ADDRESS, - "Spoof MAC Address", - "If specified, request that the WiFi device use " - "this MAC address instead of its permanent MAC address. " - "This is known as MAC cloning or spoofing.", - DBUS_TYPE_G_UCHAR_ARRAY, - G_PARAM_READWRITE)); + _nm_param_spec_specialized (NM_SETTING_WIRELESS_CLONED_MAC_ADDRESS, "", "", + DBUS_TYPE_G_UCHAR_ARRAY, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingWireless:mac-address-blacklist: * * A list of permanent MAC addresses of Wi-Fi devices to which this * connection should never apply. Each MAC address should be given in the - * standard hex-digits-and-colons notation (eg '00:11:22:33:44:55'). + * standard hex-digits-and-colons notation (eg "00:11:22:33:44:55"). **/ g_object_class_install_property (object_class, PROP_MAC_ADDRESS_BLACKLIST, - _nm_param_spec_specialized (NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST, - "MAC Address Blacklist", - "A list of permanent MAC addresses of Wi-Fi " - "devices to which this connection should " - "never apply. Each MAC address should be " - "given in the standard hex-digits-and-colons " - "notation (eg '00:11:22:33:44:55').", + _nm_param_spec_specialized (NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST, "", "", DBUS_TYPE_G_LIST_OF_STRING, - G_PARAM_READWRITE | NM_SETTING_PARAM_FUZZY_IGNORE)); + G_PARAM_READWRITE | NM_SETTING_PARAM_FUZZY_IGNORE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingWireless:seen-bssids: * * A list of BSSIDs (each BSSID formatted as a MAC address like - * '00:11:22:33:44:55') that have been detected as part of the Wi-FI network. - * NetworkManager internally tracks previously seen BSSIDs. The property is only - * meant for reading and reflects the BSSID list of NetworkManager. The changes you - * make to this property will not be preserved. + * "00:11:22:33:44:55") that have been detected as part of the Wi-Fi + * network. NetworkManager internally tracks previously seen BSSIDs. The + * property is only meant for reading and reflects the BSSID list of + * NetworkManager. The changes you make to this property will not be + * preserved. **/ g_object_class_install_property (object_class, PROP_SEEN_BSSIDS, - _nm_param_spec_specialized (NM_SETTING_WIRELESS_SEEN_BSSIDS, - "Seen BSSIDS", - "A list of BSSIDs (each BSSID formatted as a MAC " - "address like 00:11:22:33:44:55') that have been " - "detected as part of the WiFI network. " - "NetworkManager internally tracks previously seen " - "BSSIDs. The property is only meant for reading " - "and reflects the BSSID list of NetworkManager. " - "The changes you make to this property will not be " - "preserved.", + _nm_param_spec_specialized (NM_SETTING_WIRELESS_SEEN_BSSIDS, "", "", DBUS_TYPE_G_LIST_OF_STRING, - G_PARAM_READWRITE | NM_SETTING_PARAM_FUZZY_IGNORE)); + G_PARAM_READWRITE | NM_SETTING_PARAM_FUZZY_IGNORE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingWireless:mtu: @@ -1247,56 +1197,43 @@ nm_setting_wireless_class_init (NMSettingWirelessClass *setting_class) **/ g_object_class_install_property (object_class, PROP_MTU, - g_param_spec_uint (NM_SETTING_WIRELESS_MTU, - "MTU", - "If non-zero, only transmit packets of the specified " - "size or smaller, breaking larger packets up into " - "multiple Ethernet frames.", - 0, G_MAXUINT32, 0, - G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_FUZZY_IGNORE)); + g_param_spec_uint (NM_SETTING_WIRELESS_MTU, "", "", + 0, G_MAXUINT32, 0, + G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_FUZZY_IGNORE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingWireless:security: * * If the wireless connection has any security restrictions, like 802.1x, - * WEP, or WPA, set this property to '802-11-wireless-security' and ensure - * the connection contains a valid 802-11-wireless-security setting. + * WEP, or WPA, set this property to + * %NM_SETTING_WIRELESS_SECURITY_SETTING_NAME and ensure the connection + * contains a valid #NMSettingWirelessSecurity setting. * - * Deprecated: 0.9.10: No longer used. Security rescrictions are recognized by - * the presence of NM_SETTING_WIRELESS_SECURITY_SETTING_NAME in the connection. + * Deprecated: 0.9.10: No longer used. Security restrictions are recognized + * by the presence of a #NMSettingWirelessSecurity setting in the + * connection. **/ g_object_class_install_property (object_class, PROP_SEC, - g_param_spec_string (NM_SETTING_WIRELESS_SEC, - "Security", - "If the wireless connection has any security " - "restrictions, like 802.1x, WEP, or WPA, set this " - "property to '" NM_SETTING_WIRELESS_SECURITY_SETTING_NAME "' " - "and ensure the connection contains a valid " - NM_SETTING_WIRELESS_SECURITY_SETTING_NAME " setting.", - NULL, - G_PARAM_READWRITE)); + g_param_spec_string (NM_SETTING_WIRELESS_SEC, "", "", + NULL, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); /** * NMSettingWireless:hidden: * - * If %TRUE, indicates this network is a non-broadcasting network that - * hides its SSID. In this case various workarounds may take place, such - * as probe-scanning the SSID for more reliable network discovery. However, + * If %TRUE, indicates this network is a non-broadcasting network that hides + * its SSID. In this case various workarounds may take place, such as + * probe-scanning the SSID for more reliable network discovery. However, * these workarounds expose inherent insecurities with hidden SSID networks, * and thus hidden SSID networks should be used with caution. **/ g_object_class_install_property (object_class, PROP_HIDDEN, - g_param_spec_boolean (NM_SETTING_WIRELESS_HIDDEN, - "Hidden", - "If TRUE, indicates this network is a non-broadcasting " - "network that hides its SSID. In this case various " - "workarounds may take place, such as probe-scanning " - "the SSID for more reliable network discovery. " - "However, these workarounds expose inherent " - "insecurities with hidden SSID networks, and thus " - "hidden SSID networks should be used with caution.", + g_param_spec_boolean (NM_SETTING_WIRELESS_HIDDEN, "", "", FALSE, - G_PARAM_READWRITE)); + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); } diff --git a/libnm-util/nm-setting.c b/libnm-util/nm-setting.c index 0adb8055d2..a290fc766b 100644 --- a/libnm-util/nm-setting.c +++ b/libnm-util/nm-setting.c @@ -38,7 +38,7 @@ * * Each #NMSetting contains properties that describe configuration that applies * to a specific network layer (like IPv4 or IPv6 configuration) or device type - * (like Ethernet, or WiFi). A collection of individual settings together + * (like Ethernet, or Wi-Fi). A collection of individual settings together * make up an #NMConnection. Each property is strongly typed and usually has * a number of allowed values. See each #NMSetting subclass for a description * of properties and allowed values. @@ -143,13 +143,13 @@ _ensure_registered (void) * * 0: reserved for the Connection setting * - * 1: hardware-related settings like Ethernet, WiFi, Infiniband, Bridge, etc. + * 1: hardware-related settings like Ethernet, Wi-Fi, InfiniBand, Bridge, etc. * These priority 1 settings are also "base types", which means that at least * one of them is required for the connection to be valid, and their name is * valid in the 'type' property of the Connection setting. * * 2: hardware-related auxiliary settings that require a base setting to be - * successful first, like WiFi security, 802.1x, etc. + * successful first, like Wi-Fi security, 802.1x, etc. * * 3: hardware-independent settings that are required before IP connectivity * can be established, like PPP, PPPoE, etc. @@ -216,7 +216,7 @@ _nm_setting_type_is_base_type (GType type) { /* Historical oddity: PPPoE is a base-type even though it's not * priority 1. It needs to be sorted *after* lower-level stuff like - * WiFi security or 802.1x for secrets, but it's still allowed as a + * Wi-Fi security or 802.1x for secrets, but it's still allowed as a * base type. */ return _get_setting_type_priority (type) == 1 || (type == NM_TYPE_SETTING_PPPOE); @@ -1344,17 +1344,13 @@ nm_setting_class_init (NMSettingClass *setting_class) * * The setting's name, which uniquely identifies the setting within the * connection. Each setting type has a name unique to that type, for - * example 'ppp' or 'wireless' or 'wired'. + * example "ppp" or "wireless" or "wired". **/ g_object_class_install_property (object_class, PROP_NAME, - g_param_spec_string (NM_SETTING_NAME, - "Name", - "The setting's name; these names are defined by the " - "specification and cannot be changed after the object " - "has been created. Each setting class has a name, and " - "all objects of that class share the same name.", - NULL, - G_PARAM_READWRITE)); + g_param_spec_string (NM_SETTING_NAME, "", "", + NULL, + G_PARAM_READWRITE | + G_PARAM_STATIC_STRINGS)); } diff --git a/libnm-util/nm-utils.c b/libnm-util/nm-utils.c index 385731896f..28019c30a9 100644 --- a/libnm-util/nm-utils.c +++ b/libnm-util/nm-utils.c @@ -44,7 +44,7 @@ * @short_description: Utility functions * @include: nm-utils.h * - * A collection of utility functions for working SSIDs, IP addresses, WiFi + * A collection of utility functions for working SSIDs, IP addresses, Wi-Fi * access points and devices, among other things. */ @@ -259,7 +259,7 @@ nm_utils_deinit (void) * nm_utils_ssid_to_utf8: * @ssid: a byte array containing the SSID data * - * WiFi SSIDs are byte arrays, they are _not_ strings. Thus, an SSID may + * Wi-Fi SSIDs are byte arrays, they are _not_ strings. Thus, an SSID may * contain embedded NULLs and other unprintable characters. Often it is * useful to print the SSID out for debugging purposes, but that should be the * _only_ use of this function. Do not use this function for any persistent @@ -598,7 +598,7 @@ device_supports_ap_ciphers (guint32 dev_caps, * nm_utils_ap_mode_security_valid: * @type: the security type to check device capabilties against, * e.g. #NMU_SEC_STATIC_WEP - * @wifi_caps: bitfield of the capabilities of the specific WiFi device, e.g. + * @wifi_caps: bitfield of the capabilities of the specific Wi-Fi device, e.g. * #NM_WIFI_DEVICE_CAP_CIPHER_WEP40 * * Given a set of device capabilities, and a desired security type to check @@ -636,7 +636,7 @@ nm_utils_ap_mode_security_valid (NMUtilsSecurityType type, * nm_utils_security_valid: * @type: the security type to check AP flags and device capabilties against, * e.g. #NMU_SEC_STATIC_WEP - * @wifi_caps: bitfield of the capabilities of the specific WiFi device, e.g. + * @wifi_caps: bitfield of the capabilities of the specific Wi-Fi device, e.g. * #NM_WIFI_DEVICE_CAP_CIPHER_WEP40 * @have_ap: whether the @ap_flags, @ap_wpa, and @ap_rsn arguments are valid * @adhoc: whether the capabilities being tested are from an Ad-Hoc AP (IBSS) @@ -1810,7 +1810,7 @@ static struct cf_pair bg_table[] = { * nm_utils_wifi_freq_to_channel: * @freq: frequency * - * Utility function to translate a WiFi frequency to its corresponding channel. + * Utility function to translate a Wi-Fi frequency to its corresponding channel. * * Returns: the channel represented by the frequency or 0 **/ @@ -1837,7 +1837,7 @@ nm_utils_wifi_freq_to_channel (guint32 freq) * @channel: channel * @band: frequency band for wireless ("a" or "bg") * - * Utility function to translate a WiFi channel to its corresponding frequency. + * Utility function to translate a Wi-Fi channel to its corresponding frequency. * * Returns: the frequency represented by the channel of the band, * or -1 when the freq is invalid, or 0 when the band @@ -1867,7 +1867,7 @@ nm_utils_wifi_channel_to_freq (guint32 channel, const char *band) * @direction: whether going downward (0 or less) or upward (1 or more) * @band: frequency band for wireless ("a" or "bg") * - * Utility function to find out next/previous WiFi channel for a channel. + * Utility function to find out next/previous Wi-Fi channel for a channel. * * Returns: the next channel in the specified direction or 0 **/ @@ -1914,7 +1914,7 @@ nm_utils_wifi_find_next_channel (guint32 channel, int direction, char *band) * @channel: channel * @band: frequency band for wireless ("a" or "bg") * - * Utility function to verify WiFi channel validity. + * Utility function to verify Wi-Fi channel validity. * * Returns: %TRUE or %FALSE **/ |