system/NetworkManager
system/NetworkManager
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/NetworkManager/NetworkManager synced 2024-07-21 18:24:49 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

libnm-util, libnm-glib: be consistent about "Wi-Fi", "Ethernet", "InfiniBand" in docs

Browse source 
We made the UIs consistent last year, but missed the documentation.
Fix the docs to also consistently use "Wi-Fi" rather than "WiFi",
"Wifi", "wifi", or "WiFI"; "Ethernet" rather than "ethernet"; and
"InfiniBand" rather than "Infiniband".
This commit is contained in:
Dan Winship 2014-06-04 17:25:52 -04:00
parent 7475d8c28d
commit 8487a4490c
19 changed files with 88 additions and 88 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
libnm-glib/nm-access-point.c
View file

@ -184,7 +184,7 @@ nm_access_point_get_frequency (NMAccessPoint *ap)
* nm_access_point_get_bssid:
* @ap: a #NMAccessPoint
*
* Gets the Basic Service Set ID (BSSID) of the WiFi access point.
* Gets the Basic Service Set ID (BSSID) of the Wi-Fi access point.
*
* Returns: the BSSID of the access point. This is an internal string and must
* not be modified or freed.
@ -271,12 +271,12 @@ nm_access_point_get_strength (NMAccessPoint *ap)
* @ap: an #NMAccessPoint to validate @connection against
* @connection: an #NMConnection to validate against @ap
*
* Validates a given connection against a given WiFi access point to ensure that
* Validates a given connection against a given Wi-Fi access point to ensure that
* the connection may be activated with that AP. The connection must match the
* @ap's SSID, (if given) BSSID, and other attributes like security settings,
* channel, band, etc.
*
* Returns: %TRUE if the connection may be activated with this WiFi AP,
* Returns: %TRUE if the connection may be activated with this Wi-Fi AP,
* %FALSE if it cannot be.
**/
gboolean

6
libnm-glib/nm-client.c
View file

@ -590,7 +590,7 @@ activate_nm_not_running (gpointer user_data)
* @specific_object: (allow-none): the object path of a connection-type-specific
* object this activation should use. This parameter is currently ignored for
* wired and mobile broadband connections, and the value of %NULL should be used
* (ie, no specific object). For WiFi or WiMAX connections, pass the object
* (ie, no specific object). For Wi-Fi or WiMAX connections, pass the object
* path of a #NMAccessPoint or #NMWimaxNsp owned by @device, which you can
* get using nm_object_get_path(), and which will be used to complete the
* details of the newly added connection.
@ -600,7 +600,7 @@ activate_nm_not_running (gpointer user_data)
* Starts a connection to a particular network using the configuration settings
* from @connection and the network device @device. Certain connection types
* also take a "specific object" which is the object path of a connection-
* specific object, like an #NMAccessPoint for WiFi connections, or an
* specific object, like an #NMAccessPoint for Wi-Fi connections, or an
* #NMWimaxNsp for WiMAX connections, to which you wish to connect. If the
* specific object is not given, NetworkManager can, in some cases, automatically
* determine which network to connect to given the settings in @connection.
@ -680,7 +680,7 @@ add_activate_cb (DBusGProxy *proxy,
* @specific_object: (allow-none): the object path of a connection-type-specific
* object this activation should use. This parameter is currently ignored for
* wired and mobile broadband connections, and the value of %NULL should be used
* (ie, no specific object). For WiFi or WiMAX connections, pass the object
* (ie, no specific object). For Wi-Fi or WiMAX connections, pass the object
* path of a #NMAccessPoint or #NMWimaxNsp owned by @device, which you can
* get using nm_object_get_path(), and which will be used to complete the
* details of the newly added connection.

6
libnm-glib/nm-client.h
View file

@ -65,7 +65,7 @@ G_BEGIN_DECLS
* @NM_CLIENT_PERMISSION_NONE: unknown or no permission
* @NM_CLIENT_PERMISSION_ENABLE_DISABLE_NETWORK: controls whether networking
* can be globally enabled or disabled
* @NM_CLIENT_PERMISSION_ENABLE_DISABLE_WIFI: controls whether WiFi can be
* @NM_CLIENT_PERMISSION_ENABLE_DISABLE_WIFI: controls whether Wi-Fi can be
* globally enabled or disabled
* @NM_CLIENT_PERMISSION_ENABLE_DISABLE_WWAN: controls whether WWAN (3G) can be
* globally enabled or disabled
@ -76,8 +76,8 @@ G_BEGIN_DECLS
* @NM_CLIENT_PERMISSION_NETWORK_CONTROL: controls whether networking connections
* can be started, stopped, and changed
* @NM_CLIENT_PERMISSION_WIFI_SHARE_PROTECTED: controls whether a password
* protected WiFi hotspot can be created
* @NM_CLIENT_PERMISSION_WIFI_SHARE_OPEN: controls whether an open WiFi hotspot
* protected Wi-Fi hotspot can be created
* @NM_CLIENT_PERMISSION_WIFI_SHARE_OPEN: controls whether an open Wi-Fi hotspot
* can be created
* @NM_CLIENT_PERMISSION_SETTINGS_MODIFY_SYSTEM: controls whether connections
* that are available to all users can be modified

2
libnm-glib/nm-device-ethernet.c
View file

@ -194,7 +194,7 @@ connection_compatible (NMDevice *device, NMConnection *connection, GError **erro
/* Wired setting optional for PPPoE */
if (!is_pppoe && !s_wired) {
g_set_error (error, NM_DEVICE_ETHERNET_ERROR, NM_DEVICE_ETHERNET_ERROR_INVALID_ETHERNET_CONNECTION,
"The connection was not a valid ethernet connection.");
"The connection was not a valid Ethernet connection.");
return FALSE;
}

4
libnm-glib/nm-device-ethernet.h
View file

@ -38,8 +38,8 @@ G_BEGIN_DECLS
/**
* NMDeviceEthernetError:
* @NM_DEVICE_ETHERNET_ERROR_UNKNOWN: unknown or unclassified error
* @NM_DEVICE_ETHERNET_ERROR_NOT_ETHERNET_CONNECTION: the connection was not of ethernet or PPPoE type
* @NM_DEVICE_ETHERNET_ERROR_INVALID_ETHERNET_CONNECTION: the ethernet connection was invalid
* @NM_DEVICE_ETHERNET_ERROR_NOT_ETHERNET_CONNECTION: the connection was not of Ethernet or PPPoE type
* @NM_DEVICE_ETHERNET_ERROR_INVALID_ETHERNET_CONNECTION: the Ethernet connection was invalid
* @NM_DEVICE_ETHERNET_ERROR_INVALID_DEVICE_MAC: the device's MAC was invalid
* @NM_DEVICE_ETHERNET_ERROR_MAC_MISMATCH: the MACs of the connection and the device mismatched
*/

12
libnm-glib/nm-device-wifi.c
View file

@ -110,7 +110,7 @@ nm_device_wifi_error_quark (void)
*
* Creates a new #NMDeviceWifi.
*
* Returns: (transfer full): a new WiFi device
* Returns: (transfer full): a new Wi-Fi device
**/
GObject *
nm_device_wifi_new (DBusGConnection *connection, const char *path)
@ -216,7 +216,7 @@ nm_device_wifi_get_bitrate (NMDeviceWifi *device)
* nm_device_wifi_get_capabilities:
* @device: a #NMDeviceWifi
*
* Gets the WIFI capabilities of the #NMDeviceWifi.
* Gets the Wi-Fi capabilities of the #NMDeviceWifi.
*
* Returns: the capabilities
**/
@ -813,10 +813,10 @@ nm_device_wifi_class_init (NMDeviceWifiClass *wifi_class)
/**
* NMDeviceWifi::access-point-added:
* @device: the wifi device that received the signal
* @device: the Wi-Fi device that received the signal
* @ap: the new access point
*
* Notifies that a #NMAccessPoint is added to the wifi device.
* Notifies that a #NMAccessPoint is added to the Wi-Fi device.
**/
signals[ACCESS_POINT_ADDED] =
g_signal_new ("access-point-added",
@ -830,10 +830,10 @@ nm_device_wifi_class_init (NMDeviceWifiClass *wifi_class)
/**
* NMDeviceWifi::access-point-removed:
* @device: the wifi device that received the signal
* @device: the Wi-Fi device that received the signal
* @ap: the removed access point
*
* Notifies that a #NMAccessPoint is removed from the wifi device.
* Notifies that a #NMAccessPoint is removed from the Wi-Fi device.
**/
signals[ACCESS_POINT_REMOVED] =
g_signal_new ("access-point-removed",

18
libnm-glib/nm-device.c
View file

@ -581,7 +581,7 @@ nm_device_class_init (NMDeviceClass *device_class)
(object_class, PROP_DEVICE_TYPE,
g_param_spec_uint (NM_DEVICE_DEVICE_TYPE,
"Device Type",
"Numeric device type (ie ethernet, wifi, etc)",
"Numeric device type (ie Ethernet, Wi-Fi, etc)",
NM_DEVICE_TYPE_UNKNOWN, G_MAXUINT32, NM_DEVICE_TYPE_UNKNOWN,
G_PARAM_READABLE));
/**
@ -1059,7 +1059,7 @@ nm_device_get_ip_iface (NMDevice *device)
* nm_device_get_device_type:
* @device: a #NMDevice
*
* Returns the numeric type of the #NMDevice, ie ethernet, wifi, etc.
* Returns the numeric type of the #NMDevice, ie Ethernet, Wi-Fi, etc.
*
* Returns: the device type
**/
@ -2158,8 +2158,8 @@ nm_device_disconnect (NMDevice *device,
*
* Validates a given connection for a given #NMDevice object and returns
* whether the connection may be activated with the device. For example if
* @device is a WiFi device that supports only WEP encryption, the connection
* will only be valid if it is a WiFi connection which describes a WEP or open
* @device is a Wi-Fi device that supports only WEP encryption, the connection
* will only be valid if it is a Wi-Fi connection which describes a WEP or open
* network, and will not be valid if it describes a WPA network, or if it is
* an Ethernet, Bluetooth, WWAN, etc connection that is incompatible with the
* device.
@ -2201,8 +2201,8 @@ connection_compatible (NMDevice *device, NMConnection *connection, GError **erro
*
* Validates a given connection for a given #NMDevice object and returns
* whether the connection may be activated with the device. For example if
* @device is a WiFi device that supports only WEP encryption, the connection
* will only be valid if it is a WiFi connection which describes a WEP or open
* @device is a Wi-Fi device that supports only WEP encryption, the connection
* will only be valid if it is a Wi-Fi connection which describes a WEP or open
* network, and will not be valid if it describes a WPA network, or if it is
* an Ethernet, Bluetooth, WWAN, etc connection that is incompatible with the
* device.
@ -2231,10 +2231,10 @@ nm_device_connection_compatible (NMDevice *device, NMConnection *connection, GEr
*
* Filters a given list of connections for a given #NMDevice object and return
* connections which may be activated with the device. For example if @device
* is a WiFi device that supports only WEP encryption, the returned list will
* contain any WiFi connections in @connections that allow connection to
* is a Wi-Fi device that supports only WEP encryption, the returned list will
* contain any Wi-Fi connections in @connections that allow connection to
* unencrypted or WEP-enabled SSIDs. The returned list will not contain
* Ethernet, Bluetooth, WiFi WPA connections, or any other connection that is
* Ethernet, Bluetooth, Wi-Fi WPA connections, or any other connection that is
* incompatible with the device. To get the full list of connections see
* nm_remote_settings_list_connections().
*

2
libnm-glib/nm-secret-agent.h
View file

@ -141,7 +141,7 @@ typedef struct {
* return them, or to return an error, this function should be called with
* those secrets or the error.
*
* To easily create the hash table to return the WiFi PSK, you could do
* To easily create the hash table to return the Wi-Fi PSK, you could do
* something like this:
* <example>
* <title>Creating a secrets hash</title>

4
libnm-util/nm-connection.c
View file

@ -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

4
libnm-util/nm-setting-8021x.c
View file

@ -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

4
libnm-util/nm-setting-bridge.c
View file

@ -578,7 +578,7 @@ nm_setting_bridge_class_init (NMSettingBridgeClass *setting_class)
/**
* NMSettingBridge:ageing-time:
*
* The ethernet MAC address aging time, in seconds.
* The Ethernet MAC address aging time, in seconds.
*
* Since: 0.9.8
**/
@ -586,7 +586,7 @@ nm_setting_bridge_class_init (NMSettingBridgeClass *setting_class)
(object_class, PROP_AGEING_TIME,
g_param_spec_uint (NM_SETTING_BRIDGE_AGEING_TIME,
"AgeingTime",
"The ethernet MAC address aging time, in seconds.",
"The Ethernet MAC address aging time, in seconds.",
0, BR_MAX_AGEING_TIME, 300,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_INFERRABLE));
}

12
libnm-util/nm-setting-connection.c
View file

@ -1098,7 +1098,7 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class)
/**
* NMSettingConnection:id:
*
* A human readable unique idenfier for the connection, like "Work WiFi" or
* A human readable unique idenfier for the connection, like "Work Wi-Fi" or
* "T-Mobile 3G".
**/
g_object_class_install_property
@ -1119,7 +1119,7 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class)
* 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,
* to be re-created when the Wi-Fi SSID, mobile broadband network provider,
* or #NMSettingConnection:type changes.
*
* The UUID must be in the format '2815492f-7e56-435e-b2e9-246bd7cdc664'
@ -1139,7 +1139,7 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class)
"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 "
"Wi-Fi SSID, mobile broadband network provider, or the "
"connection type changes.",
NULL,
G_PARAM_READWRITE | NM_SETTING_PARAM_FUZZY_IGNORE));
@ -1152,7 +1152,7 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class)
* 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
* 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
@ -1170,7 +1170,7 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class)
"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 "
"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 "
@ -1183,7 +1183,7 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class)
*
* 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
* type's parameters. For example, for Wi-Fi devices, the name of the
* #NMSettingWireless setting.
**/
g_object_class_install_property

4
libnm-util/nm-setting-ip6-config.c
View file

@ -1022,7 +1022,7 @@ nm_setting_ip6_config_class_init (NMSettingIP6ConfigClass *setting_class)
* 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-
* 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
@ -1039,7 +1039,7 @@ nm_setting_ip6_config_class_init (NMSettingIP6ConfigClass *setting_class)
"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 "
"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 "

2
libnm-util/nm-setting-vlan.h
View file

@ -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

10
libnm-util/nm-setting-wired.c
View file

@ -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;
@ -939,7 +939,7 @@ nm_setting_wired_class_init (NMSettingWiredClass *setting_class)
/**
* NMSettingWired:mac-address:
*
* If specified, this connection will only apply to the ethernet device
* 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).
**/
@ -948,7 +948,7 @@ nm_setting_wired_class_init (NMSettingWiredClass *setting_class)
_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. "
"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,
@ -973,7 +973,7 @@ nm_setting_wired_class_init (NMSettingWiredClass *setting_class)
/**
* NMSettingWired:mac-address-blacklist:
*
* If specified, this connection will never apply to the ethernet device
* 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).
@ -983,7 +983,7 @@ nm_setting_wired_class_init (NMSettingWiredClass *setting_class)
_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 "
"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).",
DBUS_TYPE_G_LIST_OF_STRING,

20
libnm-util/nm-setting-wireless-security.c
View file

@ -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.
@ -1351,7 +1351,7 @@ nm_setting_wireless_security_class_init (NMSettingWirelessSecurityClass *setting
* 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.
* any Wi-Fi connection that uses security.
**/
g_object_class_install_property
(object_class, PROP_KEY_MGMT,
@ -1361,7 +1361,7 @@ nm_setting_wireless_security_class_init (NMSettingWirelessSecurityClass *setting
"'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.",
"be set for any Wi-Fi connection that uses security.",
NULL,
G_PARAM_READWRITE | NM_SETTING_PARAM_REQUIRED));
@ -1570,7 +1570,7 @@ nm_setting_wireless_security_class_init (NMSettingWirelessSecurityClass *setting
* 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.
* connecting to the Wi-Fi network.
**/
g_object_class_install_property
(object_class, PROP_PSK,
@ -1583,7 +1583,7 @@ nm_setting_wireless_security_class_init (NMSettingWirelessSecurityClass *setting
"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.",
"the Wi-Fi network.",
NULL,
G_PARAM_READWRITE | NM_SETTING_PARAM_SECRET));

36
libnm-util/nm-setting-wireless.c
View file

@ -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,27 +1033,27 @@ nm_setting_wireless_class_init (NMSettingWirelessClass *setting_class)
/**
* NMSettingWireless:ssid:
*
* SSID of the WiFi network.
* SSID of the Wi-Fi network.
**/
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.",
"SSID of the Wi-Fi network. Must be specified.",
DBUS_TYPE_G_UCHAR_ARRAY,
G_PARAM_READWRITE));
/**
* 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', "
"Wi-Fi network mode; one of 'infrastructure', "
"'adhoc' or 'ap'. If blank, infrastructure is assumed.",
NULL,
G_PARAM_READWRITE));
@ -1062,7 +1062,7 @@ nm_setting_wireless_class_init (NMSettingWirelessClass *setting_class)
* 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
* '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
@ -1074,7 +1074,7 @@ nm_setting_wireless_class_init (NMSettingWirelessClass *setting_class)
"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 "
"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 "
@ -1086,8 +1086,8 @@ nm_setting_wireless_class_init (NMSettingWirelessClass *setting_class)
/**
* 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.
**/
@ -1095,9 +1095,9 @@ nm_setting_wireless_class_init (NMSettingWirelessClass *setting_class)
(object_class, PROP_CHANNEL,
g_param_spec_uint (NM_SETTING_WIRELESS_CHANNEL,
"Channel",
"Wireless channel to use for the WiFi connection. The "
"Wireless channel to use for the Wi-Fi connection. The "
"device will only join (or create for Ad-Hoc networks) "
"a WiFi network on the specified channel. Because "
"a Wi-Fi 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,
@ -1165,7 +1165,7 @@ nm_setting_wireless_class_init (NMSettingWirelessClass *setting_class)
/**
* NMSettingWireless:mac-address:
*
* If specified, this connection will only apply to the WiFi device
* 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).
**/
@ -1174,7 +1174,7 @@ nm_setting_wireless_class_init (NMSettingWirelessClass *setting_class)
_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. "
"the Wi-Fi 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,
@ -1183,14 +1183,14 @@ nm_setting_wireless_class_init (NMSettingWirelessClass *setting_class)
/**
* NMSettingWireless:cloned-mac-address:
*
* If specified, request that the Wifi device use this MAC address instead of its
* 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 "
"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.",
DBUS_TYPE_G_UCHAR_ARRAY,
@ -1219,7 +1219,7 @@ nm_setting_wireless_class_init (NMSettingWirelessClass *setting_class)
* 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.
* '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.
@ -1230,7 +1230,7 @@ nm_setting_wireless_class_init (NMSettingWirelessClass *setting_class)
"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. "
"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. "

8
libnm-util/nm-setting.c
View file

@ -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);

16
libnm-util/nm-utils.c
View file

@ -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
**/