diff options
| author | Dan Williams <dcbw@redhat.com> | 2011-03-15 12:56:19 -0500 |
|---|---|---|
| committer | Dan Williams <dcbw@redhat.com> | 2011-03-15 12:56:19 -0500 |
| commit | 1c3a67aaa5d35f917381e6106838cb6b3d1ac726 (patch) | |
| tree | 5caddd2d7002e39a35a5b4dfdeece30f29871e47 /introspection | |
| parent | fcbaa00ed0793feffee4b97b0a35df21a6fe526b (diff) | |
| download | NetworkManager-1c3a67aaa5d35f917381e6106838cb6b3d1ac726.tar.gz | |
api: clarify function and usage of the Device.Udi property
Diffstat (limited to 'introspection')
| -rw-r--r-- | introspection/nm-device.xml | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/introspection/nm-device.xml b/introspection/nm-device.xml index 040f9c55f5..13c542a6d0 100644 --- a/introspection/nm-device.xml +++ b/introspection/nm-device.xml @@ -4,7 +4,18 @@ <interface name="org.freedesktop.NetworkManager.Device"> <property name="Udi" type="s" access="read"> <tp:docstring> - Unique Device Identifier. + Operating-system specific transient device hardware identifier. This + is an opaque string representing the underlying hardware for the device, + and shouldn't be used to keep track of individual devices. For some + device types (Bluetooth, Modems) it is an identifier used by the + hardware service (ie bluez or ModemManager) to refer to that device, + and client programs use it get additional information from those + services which NM does not provide. The Udi is not guaranteed to be + consistent across reboots or hotplugs of the hardware. If you're looking + for a way to uniquely track each device in your application, use the + object path. If you're looking for a way to track a specific piece of + hardware across reboot or hotplug, use a MAC address or USB serial + number. </tp:docstring> </property> <property name="Interface" type="s" access="read"> |