summaryrefslogtreecommitdiff
path: root/introspection
diff options
context:
space:
mode:
authorDan Williams <dcbw@redhat.com>2013-09-26 12:15:11 -0500
committerDan Williams <dcbw@redhat.com>2013-09-26 12:17:51 -0500
commita045c296385ca4937d34c47dcb308e00b8bed983 (patch)
tree13417899c7d6defcc253bcf34845f23ed7c10f67 /introspection
parentf820fbeeb3999e9dc97002aafe971451db198cc7 (diff)
downloadNetworkManager-a045c296385ca4937d34c47dcb308e00b8bed983.tar.gz
api: clarify lifetime and behavior of ActiveConnection's SpecificObject property (rh #1012309)
It doesn't change once it's set, and it reflects the original specific object used during activation. It will not, for example, switch to the currently active WiFi access point even if the original access point that was used as the specific object disappears.
Diffstat (limited to 'introspection')
-rw-r--r--introspection/nm-active-connection.xml6
1 files changed, 5 insertions, 1 deletions
diff --git a/introspection/nm-active-connection.xml b/introspection/nm-active-connection.xml
index d90565ae30..b6a3c48d12 100644
--- a/introspection/nm-active-connection.xml
+++ b/introspection/nm-active-connection.xml
@@ -14,7 +14,11 @@
<tp:docstring>The path of the connection.</tp:docstring>
</property>
<property name="SpecificObject" type="o" access="read">
- <tp:docstring>A specific object associated with the active connection.</tp:docstring>
+ <tp:docstring>
+ A specific object associated with the active connection. This property
+ reflects the specific object used during connection activation, and will
+ not change over the lifetime of the ActiveConnection once set.
+ </tp:docstring>
</property>
<property name="Uuid" type="s" access="read">
<tp:docstring>