diff mbox series

[v5,04/10] doc: document Stop() correctly for both DPP interfaces

Message ID 20231108172155.2129509-5-prestwoj@gmail.com (mailing list archive)
State Accepted, archived
Headers show
Series DPP PKEX Changes | expand

Checks

Context Check Description
tedd_an/pre-ci_am success Success
prestwoj/iwd-ci-gitlint success GitLint

Commit Message

James Prestwood Nov. 8, 2023, 5:21 p.m. UTC 
Stop() was separated more clearly between the two interfaces and will
now return NotFound if called on an interface that isn't currently
running.
---
 doc/device-provisioning-api.txt | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
diff mbox series

Patch

diff --git a/doc/device-provisioning-api.txt b/doc/device-provisioning-api.txt
index 2a34d4ae..9994aef5 100644
--- a/doc/device-provisioning-api.txt
+++ b/doc/device-provisioning-api.txt
@@ -18,11 +18,9 @@  Methods		string StartEnrollee()
 
 		void Stop()
 
-			Stop an enrollee.
+			Stop an enrollee or configurator that is running.
 
-			Possible errors:	net.connman.iwd.Busy
-						net.connman.iwd.Failed
-						net.connman.iwd.InvalidArguments
+			Possible errors:	net.connman.iwd.NotFound
 
 		string StartConfigurator()
 
@@ -168,6 +166,8 @@  Object path	/net/connman/iwd/{phy0,phy1,...}/{1,2,...}
 			Calling Stop() if DPP was started via the
 			DeviceProvisioning interface will not stop it.
 
+			Possible errors:	net.connman.iwd.NotFound
+
 Properties	boolean Started [readonly]
 
 			True if shared code device provisioning is currently