diff mbox series

[BlueZ,2/2] org.bluez.Adapter: Add documentation for the Connectable property.

Message ID 20240911145114.103340-3-vibhavp@gmail.com (mailing list archive)
State Accepted
Commit bf6bfc3356ef02af1eaa8248695e7e61635aff4b
Headers show
Series adapter: Add (readwrite) Connectable property. | expand

Checks

Context Check Description
tedd_an/pre-ci_am success Success
tedd_an/CheckPatch success CheckPatch PASS
tedd_an/GitLint fail WARNING: I3 - ignore-body-lines: gitlint will be switching from using Python regex 'match' (match beginning) to 'search' (match anywhere) semantics. Please review your ignore-body-lines.regex option accordingly. To remove this warning, set general.regex-style-search=True. More details: https://jorisroovers.github.io/gitlint/configuration/#regex-style-search 1: T3 Title has trailing punctuation (.): "[BlueZ,2/2] org.bluez.Adapter: Add documentation for the Connectable property."
tedd_an/IncrementalBuild success Incremental Build PASS

Commit Message

Vibhav Pant Sept. 11, 2024, 2:51 p.m. UTC
---
 doc/org.bluez.Adapter.rst | 13 +++++++++++++
 1 file changed, 13 insertions(+)
diff mbox series

Patch

diff --git a/doc/org.bluez.Adapter.rst b/doc/org.bluez.Adapter.rst
index f53728123..3f5fdc8fe 100644
--- a/doc/org.bluez.Adapter.rst
+++ b/doc/org.bluez.Adapter.rst
@@ -283,6 +283,19 @@  uint32 Class [readonly]
 	This property represents the value that is either automatically
 	configured by DMI/ACPI information or provided as static configuration.
 
+boolean Connectable [readwrite]
+```````````````````````````````
+
+	Set an adapter to connectable or non-connectable. This is a global
+	setting and should only be used by the settings application.
+
+	Setting this property to false will set the Discoverable property
+	of the adapter to false as well, which will not be reverted if
+	if Connectable is set back to true. If required, the application
+	will need to manually set Discoverable to true.
+
+	Note that this property only affects incoming connections.
+
 boolean Powered [readwrite]
 ```````````````````````````