docs: migration guide updates and additions

This commit is contained in:
Dan Williams 2011-03-03 20:45:42 -06:00
parent db2a1a79c9
commit 1f770a33ca

View file

@ -177,23 +177,6 @@
</para>
</section>
<section>
<title>AddConnection Returns Object Path of New Connection</title>
<para>
The <literal>org.freedesktop.NetworkManager.Settings.AddConnection</literal>
method call now returns the object path of the newly added connection.
Previously, if code wanted to manipulate a connection post-addition, it
had to wait for the new connection to be announced via the NewConnection
signal by matching connection UUIDs. Now the object path is returned and
this workaround is no longer required.
</para>
<para>
<emphasis role="strong">Action:</emphasis> update code that adds new
connections to handle the object path returned from AddConnection, and
remove workarounds for finding the new connection via signals.
</para>
</section>
<section>
<title>Support for WiMAX Devices</title>
<para>
@ -201,13 +184,19 @@
corresponding device type (<literal>NM_DEVICE_TYPE_WIMAX</literal>) and
a new <ulink url="spec.html#org.freedesktop.NetworkManager.Device.WiMax">
<literal>org.freedesktop.NetworkManager.Device.WiMax</literal></ulink>
D-Bus interface have been added.
D-Bus interface have been added. Furthermore, to support connection to
different WiMAX Network Service Providers (NSPs) the
<ulink url="spec.html#org.freedesktop.NetworkManager.Device.WiMax.Nsp">
<literal>org.freedesktop.NetworkManager.Device.WiMax.Nsp</literal></ulink>
interface has been added to access information about each available
WiMAX network.
</para>
<para>
<emphasis role="strong">Action:</emphasis> update code that handles
devices and/or displays status to users to recognize the new device type.
Also update code that creates new connections to allow creation of new
WiMAX connections.
devices and/or displays status to users to recognize the new device type,
and to display available WiMAX NSPs similar to how WiFi Access Points
are displayed. Also update code that creates new connections to allow
creation of new WiMAX connections.
</para>
</section>
@ -226,6 +215,42 @@
</para>
</section>
<section>
<title>Consolidated Modem Devices</title>
<para>
Many new mobile broadband devices support multiple access families, like
Qualcomm Gobi cards (CDMA/EVDO and GSM/UMTS), or multi-mode EVDO/LTE
or UMTS/LTE modems like the Pantech UML290. The previous hard split
between CDMA/EVDO and GSM/UMTS device classes was not flexible enough to
deal with these new multi-mode devices. Thus the previously separate
CDMA and GSM device classes have been combined into a single Modem
device class, which exposes both hardware "ModemCapabilities" and
runtime "CurrentCapabilities" which represent generic access technology
families like CDMA/EVDO, GSM/UMTS, and LTE which the device supports.
ModemCapabilities indicate all the access technology families which the
modem is capable of supporting, while CurrentCapabilities indicate the
immediate access technology families the device supports without reloading
the firmware and thus restarting the device.
</para>
<para>
Along with this change, the
<literal>org.freedesktop.NetworkManager.Device.Serial</literal>
interface has been removed as it's functionality will be incorporated
into the
<ulink url="spec.html#org.freedesktop.NetworkManager.Device.Modem">
<literal>org.freedesktop.NetworkManager.Device.Modem</literal></ulink>
interface in the future.
</para>
<para>
<emphasis role="strong">Action:</emphasis> combine code that checks for
the old CDMA and GSM device types, and instead handle the new Modem device
type. Where behavior must change based on the capabilities of the device,
check the CurrentCapabilities device property to determine whether to
treat the device as CDMA, GSM, or LTE for purposes of configuration and
status.
</para>
</section>
</section>
</chapter>