diff mbox series

adapter-api: Document per-client discovery sessions

Message ID 20220223090059.310361-1-hadess@hadess.net
State New
Headers show
Series adapter-api: Document per-client discovery sessions | expand

Commit Message

Bastien Nocera Feb. 23, 2022, 9 a.m. UTC 
The fact that each client can start its own discovery wasn't clear from
the documentation and only becomes obvious when reading the sources.
---
 doc/adapter-api.txt | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

Comments

bluez.test.bot@gmail.com Feb. 23, 2022, 10:21 a.m. UTC | #1 
This is automated email and please do not reply to this email!

Dear submitter,

Thank you for submitting the patches to the linux bluetooth mailing list.
This is a CI test results with your patch series:
PW Link:https://patchwork.kernel.org/project/bluetooth/list/?series=617064

---Test result---

Test Summary:
CheckPatch                    PASS      1.47 seconds
GitLint                       PASS      1.01 seconds
Prep - Setup ELL              PASS      42.66 seconds
Build - Prep                  PASS      0.72 seconds
Build - Configure             PASS      8.65 seconds
Build - Make                  PASS      1406.67 seconds
Make Check                    PASS      11.89 seconds
Make Check w/Valgrind         PASS      444.90 seconds
Make Distcheck                PASS      231.57 seconds
Build w/ext ELL - Configure   PASS      8.72 seconds
Build w/ext ELL - Make        PASS      1416.29 seconds
Incremental Build with patchesPASS      0.00 seconds



---
Regards,
Linux Bluetooth
diff mbox series

Patch

diff --git a/doc/adapter-api.txt b/doc/adapter-api.txt
index 490608e8d..48466ab75 100644
--- a/doc/adapter-api.txt
+++ b/doc/adapter-api.txt
@@ -21,6 +21,9 @@  Methods		void StartDiscovery()
 
 			During discovery RSSI delta-threshold is imposed.
 
+			Each client can request a single device discovery session
+			per adapter.
+
 			Possible errors: org.bluez.Error.NotReady
 					 org.bluez.Error.Failed
 					 org.bluez.Error.InProgress
@@ -32,7 +35,8 @@  Methods		void StartDiscovery()
 
 			Note that a discovery procedure is shared between all
 			discovery sessions thus calling StopDiscovery will only
-			release a single session.
+			release a single session and discovery will stop when
+			all sessions from all clients have finished.
 
 			Possible errors: org.bluez.Error.NotReady
 					 org.bluez.Error.Failed