Imported Upstream version 0.9.0 upstream/0.9.0

1 files changed, 11 insertions, 2 deletions

diff --git a/introspection/nm-secret-agent.xml b/introspection/nm-secret-agent.xml
index daf287c6..0a67efdc 100644
--- a/introspection/nm-secret-agent.xml
+++ b/introspection/nm-secret-agent.xml
@@ -5,7 +5,13 @@
     <interface name="org.freedesktop.NetworkManager.SecretAgent">
         <tp:docstring>
             Private D-Bus interface used by secret agents that store and provide
-            secrets to NetworkManager.
+            secrets to NetworkManager.  If an agent provides secrets to
+            NetworkManager as part of connection creation, and the some of those
+            secrets are "agent owned" the agent should store those secrets
+            itself and should not expect its SaveSecrets() method to be called.
+            SaveSecrets() will be called eg if some program other than the
+            agent itself (like a connection editor) changes the secrets out of
+            band.
         </tp:docstring>
 
         <method name="GetSecrets">
@@ -123,7 +129,10 @@
                 <tp:docstring>
                     Nested settings maps containing the entire connection
                     (including secrets), for which the agent should save the
-                    secrets to backing storage.
+                    secrets to backing storage.  This method will not be called
+                    when the agent itself is the process creating or updating
+                    a connection; in that case the agent is assumed to have
+                    already saved those secrets since it had them already.
                 </tp:docstring>
             </arg>
             <arg name="connection_path" type="o" direction="in">