From: Luiz Augusto von Dentz <[email protected]>
This renames adapter-api.txt to org.bluez.Adapter.rst and generate a
manpage org.bluez.Adapter.5.
---
Makefile.am | 8 +-
doc/adapter-api.txt | 373 ----------------------------------
doc/org.bluez.Adapter.rst | 412 ++++++++++++++++++++++++++++++++++++++
3 files changed, 416 insertions(+), 377 deletions(-)
delete mode 100644 doc/adapter-api.txt
create mode 100644 doc/org.bluez.Adapter.rst
diff --git a/Makefile.am b/Makefile.am
index 8d35dbb55e69..5eb94985a1b7 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -357,14 +357,14 @@ CLEANFILES += $(builtin_files) src/bluetooth.service
if MANPAGES
man_MANS += src/bluetoothd.8
-man_MANS += doc/org.bluez.DeviceSet.5
+man_MANS += doc/org.bluez.Adapter.5 doc/org.bluez.DeviceSet.5
man_MANS += doc/org.bluez.Media.5 doc/org.bluez.MediaControl.5 \
doc/org.bluez.MediaPlayer.5 doc/org.bluez.MediaFolder.5 \
doc/org.bluez.MediaItem.5 doc/org.bluez.MediaEndpoint.5 \
doc/org.bluez.MediaTransport.5
endif
manual_pages += src/bluetoothd.8
-manual_pages += doc/org.bluez.DeviceSet.5
+manual_pages += doc/org.bluez.Adapter.5 doc/org.bluez.DeviceSet.5
manual_pages += doc/org.bluez.Media.5 doc/org.bluez.MediaControl.5 \
doc/org.bluez.MediaPlayer.5 doc/org.bluez.MediaFolder.5 \
doc/org.bluez.MediaItem.5 doc/org.bluez.MediaEndpoint.5 \
@@ -405,12 +405,12 @@ EXTRA_DIST += doc/assigned-numbers.txt doc/supported-features.txt \
doc/settings-storage.txt
EXTRA_DIST += doc/mgmt-api.txt \
- doc/adapter-api.txt doc/device-api.txt \
+ doc/device-api.txt \
doc/agent-api.txt doc/profile-api.txt \
doc/network-api.txt doc/health-api.txt \
doc/sap-api.txt doc/input-api.txt
-EXTRA_DIST += doc/org.bluez.DeviceSet.rst
+EXTRA_DIST += doc/org.bluez.Adapter.rst doc/org.bluez.DeviceSet.rst
EXTRA_DIST += doc/org.bluez.Media.rst doc/org.bluez.MediaControl.rst \
doc/org.bluez.MediaPlayer.rst doc/org.bluez.MediaFolder.rst \
diff --git a/doc/adapter-api.txt b/doc/adapter-api.txt
deleted file mode 100644
index 10c290c62fe2..000000000000
--- a/doc/adapter-api.txt
+++ /dev/null
@@ -1,373 +0,0 @@
-BlueZ D-Bus Adapter API description
-***********************************
-
-
-Adapter hierarchy
-=================
-
-Service org.bluez
-Interface org.bluez.Adapter1
-Object path [variable prefix]/{hci0,hci1,...}
-
-Methods void StartDiscovery()
-
- This method starts the device discovery session. This
- includes an inquiry procedure and remote device name
- resolving. Use StopDiscovery to release the sessions
- acquired.
-
- This process will start creating Device objects as
- new devices are discovered.
-
- 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
-
- void StopDiscovery()
-
- This method will cancel any previous StartDiscovery
- transaction.
-
- Note that a discovery procedure is shared between all
- discovery sessions thus calling StopDiscovery will only
- 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
- org.bluez.Error.NotAuthorized
-
- void RemoveDevice(object device)
-
- This removes the remote device object at the given
- path. It will remove also the pairing information.
-
- Possible errors: org.bluez.Error.InvalidArguments
- org.bluez.Error.Failed
-
- void SetDiscoveryFilter(dict filter)
-
- This method sets the device discovery filter for the
- caller. When this method is called with no filter
- parameter, filter is removed.
-
- Parameters that may be set in the filter dictionary
- include the following:
-
- array{string} UUIDs
-
- Filter by service UUIDs, empty means match
- _any_ UUID.
-
- When a remote device is found that advertises
- any UUID from UUIDs, it will be reported if:
- - Pathloss and RSSI are both empty.
- - only Pathloss param is set, device advertise
- TX pwer, and computed pathloss is less than
- Pathloss param.
- - only RSSI param is set, and received RSSI is
- higher than RSSI param.
-
- int16 RSSI
-
- RSSI threshold value.
-
- PropertiesChanged signals will be emitted
- for already existing Device objects, with
- updated RSSI value. If one or more discovery
- filters have been set, the RSSI delta-threshold,
- that is imposed by StartDiscovery by default,
- will not be applied.
-
- uint16 Pathloss
-
- Pathloss threshold value.
-
- PropertiesChanged signals will be emitted
- for already existing Device objects, with
- updated Pathloss value.
-
- string Transport (Default "auto")
-
- Transport parameter determines the type of
- scan.
-
- Possible values:
- "auto" - interleaved scan
- "bredr" - BR/EDR inquiry
- "le" - LE scan only
-
- If "le" or "bredr" Transport is requested,
- and the controller doesn't support it,
- org.bluez.Error.Failed error will be returned.
- If "auto" transport is requested, scan will use
- LE, BREDR, or both, depending on what's
- currently enabled on the controller.
-
- bool DuplicateData (Default: true)
-
- Disables duplicate detection of advertisement
- data.
-
- When enabled PropertiesChanged signals will be
- generated for either ManufacturerData and
- ServiceData everytime they are discovered.
-
- bool Discoverable (Default: false)
-
- Make adapter discoverable while discovering,
- if the adapter is already discoverable setting
- this filter won't do anything.
-
- string Pattern (Default: none)
-
- Discover devices where the pattern matches
- either the prefix of the address or
- device name which is convenient way to limited
- the number of device objects created during a
- discovery.
-
- When set disregards device discoverable flags.
-
- Note: The pattern matching is ignored if there
- are other client that don't set any pattern as
- it work as a logical OR, also setting empty
- string "" pattern will match any device found.
-
- When discovery filter is set, Device objects will be
- created as new devices with matching criteria are
- discovered regardless of they are connectable or
- discoverable which enables listening to
- non-connectable and non-discoverable devices.
-
- When multiple clients call SetDiscoveryFilter, their
- filters are internally merged, and notifications about
- new devices are sent to all clients. Therefore, each
- client must check that device updates actually match
- its filter.
-
- When SetDiscoveryFilter is called multiple times by the
- same client, last filter passed will be active for
- given client.
-
- SetDiscoveryFilter can be called before StartDiscovery.
- It is useful when client will create first discovery
- session, to ensure that proper scan will be started
- right after call to StartDiscovery.
-
- Possible errors: org.bluez.Error.NotReady
- org.bluez.Error.NotSupported
- org.bluez.Error.Failed
-
- array{string} GetDiscoveryFilters()
-
- Return available filters that can be given to
- SetDiscoveryFilter.
-
- Possible errors: None
-
- object ConnectDevice(dict properties) [experimental]
-
- This method connects to device without need of
- performing General Discovery. Connection mechanism is
- similar to Connect method from Device1 interface with
- exception that this method returns success when physical
- connection is established and you can specify bearer to
- connect with parameter. After this method returns,
- services discovery will continue and any supported
- profile will be connected. There is no need for calling
- Connect on Device1 after this call. If connection was
- successful this method returns object path to created
- device object or device that already exist.
-
- Parameters that may be set in the filter dictionary
- include the following:
-
- string Address
-
- The Bluetooth device address of the remote
- device. This parameter is mandatory.
-
- string AddressType
-
- The Bluetooth device Address Type. This is
- address type that should be used for initial
- connection. If this parameter is not present
- BR/EDR device is created.
-
- Possible values:
- "public" - Public address
- "random" - Random address
-
- Possible errors: org.bluez.Error.InvalidArguments
- org.bluez.Error.AlreadyExists
- org.bluez.Error.NotSupported
- org.bluez.Error.NotReady
- org.bluez.Error.Failed
-
-Properties string Address [readonly]
-
- The Bluetooth device address.
-
- string AddressType [readonly]
-
- The Bluetooth Address Type. For dual-mode and BR/EDR
- only adapter this defaults to "public". Single mode LE
- adapters may have either value. With privacy enabled
- this contains type of Identity Address and not type of
- address used for connection.
-
- Possible values:
- "public" - Public address
- "random" - Random address
-
- string Name [readonly]
-
- The Bluetooth system name (pretty hostname).
-
- This property is either a static system default
- or controlled by an external daemon providing
- access to the pretty hostname configuration.
-
- string Alias [readwrite]
-
- The Bluetooth friendly name. This value can be
- changed.
-
- In case no alias is set, it will return the system
- provided name. Setting an empty string as alias will
- convert it back to the system provided name.
-
- When resetting the alias with an empty string, the
- property will default back to system name.
-
- On a well configured system, this property never
- needs to be changed since it defaults to the system
- name and provides the pretty hostname. Only if the
- local name needs to be different from the pretty
- hostname, this property should be used as last
- resort.
-
- uint32 Class [readonly]
-
- The Bluetooth class of device.
-
- This property represents the value that is either
- automatically configured by DMI/ACPI information
- or provided as static configuration.
-
- boolean Powered [readwrite]
-
- Switch an adapter on or off. This will also set the
- appropriate connectable state of the controller.
-
- The value of this property is not persistent. After
- restart or unplugging of the adapter it will reset
- back to false.
-
- string PowerState [readonly, experimental]
-
- The power state of an adapter.
-
- The power state will show whether the adapter is
- turning off, or turning on, as well as being on
- or off.
-
- Possible values:
- "on" - powered on
- "off" - powered off
- "off-enabling" - transitioning from "off" to "on"
- "on-disabling" - transitioning from "on" to "off"
- "off-blocked" - blocked by rfkill
-
- boolean Discoverable [readwrite]
-
- Switch an adapter to discoverable or non-discoverable
- to either make it visible or hide it. This is a global
- setting and should only be used by the settings
- application.
-
- If the DiscoverableTimeout is set to a non-zero
- value then the system will set this value back to
- false after the timer expired.
-
- In case the adapter is switched off, setting this
- value will fail.
-
- When changing the Powered property the new state of
- this property will be updated via a PropertiesChanged
- signal.
-
- For any new adapter this settings defaults to false.
-
- boolean Pairable [readwrite]
-
- Switch an adapter to pairable or non-pairable. This is
- a global setting and should only be used by the
- settings application.
-
- Note that this property only affects incoming pairing
- requests.
-
- For any new adapter this settings defaults to true.
-
- uint32 PairableTimeout [readwrite]
-
- The pairable timeout in seconds. A value of zero
- means that the timeout is disabled and it will stay in
- pairable mode forever.
-
- The default value for pairable timeout should be
- disabled (value 0).
-
- uint32 DiscoverableTimeout [readwrite]
-
- The discoverable timeout in seconds. A value of zero
- means that the timeout is disabled and it will stay in
- discoverable/limited mode forever.
-
- The default value for the discoverable timeout should
- be 180 seconds (3 minutes).
-
- boolean Discovering [readonly]
-
- Indicates that a device discovery procedure is active.
-
- array{string} UUIDs [readonly]
-
- List of 128-bit UUIDs that represents the available
- local services.
-
- string Modalias [readonly, optional]
-
- Local Device ID information in modalias format
- used by the kernel and udev.
-
- array{string} Roles [readonly]
-
- List of supported roles. Possible values:
- "central": Supports the central role.
- "peripheral": Supports the peripheral role.
- "central-peripheral": Supports both roles
- concurrently.
-
- array{string} ExperimentalFeatures [readonly, optional]
-
- List of 128-bit UUIDs that represents the experimental
- features currently enabled.
-
- uint16 Manufacturer [readonly]
-
- The manufacturer of the device, as a uint16 company
- identifier defined by the Core Bluetooth Specification.
-
- byte Version [readonly]
-
- The Bluetooth version supported by the device, as a
- core version code defined by the Core Bluetooth
- Specification.
diff --git a/doc/org.bluez.Adapter.rst b/doc/org.bluez.Adapter.rst
new file mode 100644
index 000000000000..f537281238e4
--- /dev/null
+++ b/doc/org.bluez.Adapter.rst
@@ -0,0 +1,412 @@
+=================
+org.bluez.Adapter
+=================
+
+-------------------------------------
+BlueZ D-Bus Adapter API documentation
+-------------------------------------
+
+:Version: BlueZ
+:Date: October 2023
+:Manual section: 5
+:Manual group: Linux System Administration
+
+Interface
+=========
+
+:Service: org.bluez
+:Interface: org.bluez.Adapter1
+:Object path: [variable prefix]/{hci0,hci1,...}
+
+Methods
+-------
+
+void StartDiscovery()
+`````````````````````
+
+ Starts device discovery session which may include starting an inquiry
+ and/or scanning procedures and remote device name resolving.
+
+ Use **StopDiscovery** to release the sessions acquired.
+
+ This process will start creating Device objects as new devices are
+ discovered.
+
+ 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:
+
+void StopDiscovery()
+````````````````````
+
+ Stops device discovery session started by **StartDiscovery**.
+
+ Note that a discovery procedure is shared between all discovery sessions
+ thus calling StopDiscovery will only 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:
+ :org.bluez.Error.NotAuthorized:
+
+void RemoveDevice(object device)
+````````````````````````````````
+
+ Removes the remote device object at the given path including cahed
+ information such as bonding information.
+
+ Possible errors:
+
+ :org.bluez.Error.InvalidArguments:
+ :org.bluez.Error.Failed:
+
+void SetDiscoveryFilter(dict filter)
+````````````````````````````````````
+
+ Sets the device discovery filter for the caller. When this method is
+ called with no filter parameter, filter is removed.
+
+ Possible filter values:
+
+ :array{string} UUIDs:
+
+ Filter by service UUIDs, empty means match *any* UUID.
+
+ When a remote device is found that advertises any UUID from
+ UUIDs, it will be reported if:
+
+ - **Pathloss** and **RSSI** are both empty.
+ - only **Pathloss** param is set, device advertise TX power, and
+ computed pathloss is less than Pathloss param.
+ - only **RSSI** param is set, and received RSSI is higher
+ than RSSI param.
+
+ :int16 RSSI:
+
+ RSSI threshold value.
+
+ PropertiesChanged signals will be emitted for already existing
+ Device objects, with updated RSSI value. If one or more
+ discovery filters have been set, the RSSI delta-threshold, that
+ is imposed by StartDiscovery by default, will not be applied.
+
+ :uint16 Pathloss:
+
+ Pathloss threshold value.
+
+ PropertiesChanged signals will be emitted for already existing
+ Device objects, with updated Pathloss value.
+
+ :string Transport (Default "auto"):
+
+ Transport parameter determines the type of scan.
+
+ Possible values:
+
+ :"auto":
+
+ Interleaved scan, use LE, BREDR, or both, depending on
+ what's currently enabled.
+
+ :"bredr":
+
+ BR/EDR inquiry only.
+
+ :"le":
+
+ LE scan only.
+
+
+ :bool DuplicateData (Default true):
+
+ Disables duplicate detection of advertisement data.
+
+ When enabled PropertiesChanged signals will be generated for
+ either ManufacturerData and ServiceData everytime they are
+ discovered.
+
+ :bool Discoverable (Default false):
+
+ Make adapter discoverable while discovering, if the adapter is
+ already discoverable setting this filter won't do anything.
+
+ :string Pattern (Default none):
+
+ Discover devices where the pattern matches either the prefix of
+ the address or device name which is convenient way to limited
+ the number of device objects created during a discovery.
+
+ When set disregards device discoverable flags.
+
+ Note: The pattern matching is ignored if there are other client
+ that don't set any pattern as it work as a logical OR, also
+ setting empty string "" pattern will match any device found.
+
+ When discovery filter is set, Device objects will be created as
+ new devices with matching criteria are discovered regardless of
+ they are connectable or discoverable which enables listening to
+ non-connectable and non-discoverable devices.
+
+ When multiple clients call SetDiscoveryFilter, their filters are
+ internally merged, and notifications about new devices are sent
+ to all clients. Therefore, each client must check that device
+ updates actually match its filter.
+
+ When SetDiscoveryFilter is called multiple times by the same
+ client, last filter passed will be active for given client.
+
+ SetDiscoveryFilter can be called before StartDiscovery.
+ It is useful when client will create first discovery session,
+ to ensure that proper scan will be started right after call to
+ StartDiscovery.
+
+ Possible errors:
+
+ :org.bluez.Error.NotReady:
+ :org.bluez.Error.NotSupported:
+ :org.bluez.Error.Failed:
+
+array{string} GetDiscoveryFilters()
+```````````````````````````````````
+
+ Returns available filters that can be given to **SetDiscoveryFilter**.
+
+ Possible errors: None
+
+object ConnectDevice(dict properties) [experimental]
+````````````````````````````````````````````````````
+
+ connects to device without need of performing General Discovery.
+ Connection mechanism is similar to Connect method on
+ **org.bluez.Device1(5)** interface with exception that this method
+ returns success when physical connection is established and you can
+ specify bearer to connect with parameter. After this method returns,
+ services discovery will continue and any supported profile will be
+ connected. There is no need for calling Connect on Device1 after this
+ call. If connection was successful this method returns object path to
+ created device object or device that already exist.
+
+ Possible properties values:
+
+ :string Address (Mandatory):
+
+ The Bluetooth device address of the remote device.
+
+ :string AddressType (Default "BR/EDR"):
+
+ The Bluetooth device Address Type. This is address type that
+ should be used for initial connection.
+
+ Possible values:
+
+ :"public":
+
+ Public address
+
+ :"random":
+
+ Random address
+
+ Possible errors:
+
+ :org.bluez.Error.InvalidArguments:
+ :org.bluez.Error.AlreadyExists:
+ :org.bluez.Error.NotSupported:
+ :org.bluez.Error.NotReady:
+ :org.bluez.Error.Failed:
+
+Properties
+----------
+
+string Address [readonly]
+`````````````````````````
+
+ The Bluetooth device address.
+
+string AddressType [readonly]
+`````````````````````````````
+
+ The Bluetooth Address Type. For dual-mode and BR/EDR only adapter this
+ defaults to "public". Single mode LE adapters may have either value.
+ With privacy enabled this contains type of Identity Address and not
+ type of address used for connection.
+
+ Possible values:
+
+ :"public":
+
+ Public address.
+
+
+ :"random:
+
+ Random address.
+
+string Name [readonly]
+``````````````````````
+
+ The Bluetooth system name (pretty hostname).
+
+ This property is either a static system default or controlled by an
+ external daemon providing access to the pretty hostname configuration.
+
+string Alias [readwrite]
+````````````````````````
+
+ The Bluetooth friendly name. This value can be changed.
+
+ In case no alias is set, it will return the system provided name.
+ Setting an empty string as alias will convert it back to the system
+ provided name.
+
+ When resetting the alias with an empty string, the property will default
+ back to system name.
+
+ On a well configured system, this property never needs to be changed
+ since it defaults to the system name and provides the pretty hostname.
+ Only if the local name needs to be different from the pretty hostname,
+ this property should be used as last resort.
+
+uint32 Class [readonly]
+```````````````````````
+
+ The Bluetooth class of device.
+
+ This property represents the value that is either automatically
+ configured by DMI/ACPI information or provided as static configuration.
+
+boolean Powered [readwrite]
+```````````````````````````
+
+ Switch an adapter on or off. This will also set the appropriate
+ connectable state of the controller.
+
+ The value of this property is not persistent. After restart or
+ unplugging of the adapter it will reset back to false.
+
+string PowerState [readonly, experimental]
+``````````````````````````````````````````
+
+ The power state of an adapter.
+
+ The power state will show whether the adapter is turning off, or turning
+ on, as well as being on or off.
+
+ Possible values:
+
+ :"on":
+
+ Powered on.
+
+ :"off":
+
+ Powered off
+
+ :"off-enabling":
+
+ Transitioning from "off" to "on".
+
+ :"on-disabling":
+
+ Transitioning from "on" to "off".
+
+ :"off-blocked":
+
+ Blocked by rfkill.
+
+boolean Discoverable [readwrite] (Default: false)
+`````````````````````````````````````````````````
+
+ Switch an adapter to discoverable or non-discoverable to either make it
+ visible or hide it. This is a global setting and should only be used by
+ the settings application.
+
+ If the DiscoverableTimeout is set to a non-zero value then the system
+ will set this value back to false after the timer expired.
+
+ In case the adapter is switched off, setting this value will fail.
+
+ When changing the Powered property the new state of this property will
+ be updated via a PropertiesChanged signal.
+
+boolean Pairable [readwrite] (Default: true)
+````````````````````````````````````````````
+
+ Switch an adapter to pairable or non-pairable. This is a global setting
+ and should only be used by the settings application.
+
+ Note that this property only affects incoming pairing requests.
+
+uint32 PairableTimeout [readwrite] (Default: 0)
+```````````````````````````````````````````````
+
+ The pairable timeout in seconds. A value of zero means that the timeout
+ is disabled and it will stay in pairable mode forever.
+
+uint32 DiscoverableTimeout [readwrite] (Default: 180)
+`````````````````````````````````````````````````````
+
+ The discoverable timeout in seconds. A value of zero means that the
+ timeout is disabled and it will stay in discoverable/limited mode
+ forever.
+
+boolean Discovering [readonly]
+``````````````````````````````
+
+ Indicates that a device discovery procedure is active.
+
+array{string} UUIDs [readonly]
+``````````````````````````````
+
+ List of 128-bit UUIDs that represents the available local services.
+
+string Modalias [readonly, optional]
+````````````````````````````````````
+
+ Local Device ID information in modalias format used by the kernel and
+ udev.
+
+array{string} Roles [readonly]
+``````````````````````````````
+
+ List of supported roles.
+
+ Possible values:
+
+ :"central":
+
+ Supports the central role.
+
+ :"peripheral":
+
+ Supports the peripheral role.
+
+ :"central-peripheral":
+
+ Supports both roles concurrently.
+
+array{string} ExperimentalFeatures [readonly, optional]
+```````````````````````````````````````````````````````
+
+ List of 128-bit UUIDs that represents the experimental features
+ currently enabled.
+
+uint16 Manufacturer [readonly]
+``````````````````````````````
+
+ The manufacturer of the device, as a uint16 company identifier defined
+ by the Core Bluetooth Specification.
+
+byte Version [readonly]
+```````````````````````
+
+ The Bluetooth version supported by the device, as a core version code
+ defined by the Core Bluetooth Specification.
--
2.41.0
From: Luiz Augusto von Dentz <[email protected]>
This renames admin-policy-api.txt to org.bluez.AdminPolicy*.rst and
generate manpages org.bluez.AdminPolicy*.5.
---
Makefile.am | 12 ++++--
doc/admin-policy-api.txt | 65 -----------------------------
doc/org.bluez.AdminPolicySet.rst | 52 +++++++++++++++++++++++
doc/org.bluez.AdminPolicyStatus.rst | 49 ++++++++++++++++++++++
4 files changed, 110 insertions(+), 68 deletions(-)
delete mode 100644 doc/admin-policy-api.txt
create mode 100644 doc/org.bluez.AdminPolicySet.rst
create mode 100644 doc/org.bluez.AdminPolicyStatus.rst
diff --git a/Makefile.am b/Makefile.am
index ae44937a50e1..53dd12615560 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -363,7 +363,9 @@ man_MANS += doc/org.bluez.Adapter.5 doc/org.bluez.Device.5 \
doc/org.bluez.Profile.5 doc/org.bluez.NetworkServer.5 \
doc/org.bluez.Network.5 doc/org.bluez.Input.5 \
doc/org.bluez.BatteryProviderManager.5 \
- doc/org.bluez.BatteryProvider.5 doc/org.bluez.Battery.5
+ doc/org.bluez.BatteryProvider.5 doc/org.bluez.Battery.5 \
+ doc/org.bluez.AdminPolicySet.5 \
+ doc/org.bluez.AdminPolicyStatus.5
man_MANS += doc/org.bluez.Media.5 doc/org.bluez.MediaControl.5 \
doc/org.bluez.MediaPlayer.5 doc/org.bluez.MediaFolder.5 \
doc/org.bluez.MediaItem.5 doc/org.bluez.MediaEndpoint.5 \
@@ -384,7 +386,9 @@ manual_pages += doc/org.bluez.Adapter.5 doc/org.bluez.Device.5 \
doc/org.bluez.Profile.5 doc/org.bluez.NetworkServer.5 \
doc/org.bluez.Network.5 doc/org.bluez.Input.5\
doc/org.bluez.BatteryProviderManager.5 \
- doc/org.bluez.BatteryProvider.5 doc/org.bluez.Battery.5
+ doc/org.bluez.BatteryProvider.5 doc/org.bluez.Battery.5 \
+ doc/org.bluez.AdminPolicySet.5 \
+ doc/org.bluez.AdminPolicyStatus.5
manual_pages += doc/org.bluez.Media.5 doc/org.bluez.MediaControl.5 \
doc/org.bluez.MediaPlayer.5 doc/org.bluez.MediaFolder.5 \
doc/org.bluez.MediaItem.5 doc/org.bluez.MediaEndpoint.5 \
@@ -442,7 +446,9 @@ EXTRA_DIST += doc/org.bluez.Adapter.rst doc/org.bluez.Device.rst \
doc/org.bluez.Profile.rst doc/org.bluez.NetworkServer.rst \
doc/org.bluez.Network.rst doc/org.bluez.Input.rst \
doc/org.bluez.BatteryProviderManager.rst \
- doc/org.bluez.BatteryProvider.rst doc/org.bluez.Battery.rst
+ doc/org.bluez.BatteryProvider.rst doc/org.bluez.Battery.rst \
+ doc/org.bluez.AdminPolicySet.rst \
+ doc/org.bluez.AdminPolicyStatus.rst
EXTRA_DIST += doc/org.bluez.Media.rst doc/org.bluez.MediaControl.rst \
doc/org.bluez.MediaPlayer.rst doc/org.bluez.MediaFolder.rst \
diff --git a/doc/admin-policy-api.txt b/doc/admin-policy-api.txt
deleted file mode 100644
index 3f116901dbd7..000000000000
--- a/doc/admin-policy-api.txt
+++ /dev/null
@@ -1,65 +0,0 @@
-BlueZ D-Bus Admin Policy API description
-***********************************
-
-This API provides methods to control the behavior of bluez as an administrator.
-
-Interface AdminPolicySet1 provides methods to set policies. Once the policy is
-set successfully, it will affect all clients and stay persistently even after
-restarting Bluetooth Daemon. The only way to clear it is to overwrite the
-policy with the same method.
-
-Interface AdminPolicyStatus1 provides readonly properties to indicate the
-current values of admin policy.
-
-
-Admin Policy Set hierarchy
-=================
-
-Service org.bluez
-Interface org.bluez.AdminPolicySet1
-Object path [variable prefix]/{hci0,hci1,...}
-
-Methods void SetServiceAllowList(array{string} UUIDs)
-
- This method sets the service allowlist by specifying
- service UUIDs.
-
- When SetServiceAllowList is called, bluez will block
- incoming and outgoing connections to the service not in
- UUIDs for all of the clients.
-
- Any subsequent calls to this method will supersede any
- previously set allowlist values. Calling this method
- with an empty array will allow any service UUIDs to be
- used.
-
- The default value is an empty array.
-
- Possible errors: org.bluez.Error.InvalidArguments
- org.bluez.Error.Failed
-
-
-Admin Policy Status hierarchy
-=================
-
-Service org.bluez
-Interface org.bluez.AdminPolicyStatus1
-Object path [variable prefix]/{hci0,hci1,...}
-
-Properties array{string} ServiceAllowList [readonly]
-
- Current value of service allow list.
-
-
-
-Admin Policy Status hierarchy
-=================
-
-Service org.bluez
-Interface org.bluez.AdminPolicyStatus1
-Object path [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX
-
-Properties bool IsAffectedByPolicy [readonly]
-
- Indicate if there is any auto-connect profile in this
- device is not allowed by admin policy.
diff --git a/doc/org.bluez.AdminPolicySet.rst b/doc/org.bluez.AdminPolicySet.rst
new file mode 100644
index 000000000000..7ce4efcfed99
--- /dev/null
+++ b/doc/org.bluez.AdminPolicySet.rst
@@ -0,0 +1,52 @@
+========================
+org.bluez.AdminPolicySet
+========================
+
+--------------------------------------------
+BlueZ D-Bus AdminPolicySet API documentation
+--------------------------------------------
+
+:Version: BlueZ
+:Date: October 2023
+:Manual section: 5
+:Manual group: Linux System Administration
+
+Description
+============
+
+This API provides methods to control the behavior of **bluetoothd(8)** as an
+administrator.
+
+Interface AdminPolicySet1 provides methods to set policies. Once the policy is
+set successfully, it will affect all clients and stay persistently even after
+restarting **bluetoothd(8)**. The only way to clear it is to overwrite the
+policy with the same method.
+
+Interface
+=========
+
+:Service: org.bluez
+:Interface: org.bluez.AdminPolicySet1 [experimental]
+:Object path: [variable prefix]/{hci0,hci1,...}
+
+Methods
+-------
+
+void SetServiceAllowList(array{string} UUIDs)
+`````````````````````````````````````````````
+
+ Sets the service allowlist by specifying service UUIDs.
+
+ When called, **bluetoothd(8)** will block incoming and outgoing
+ connections to the service not in UUIDs for all of the clients.
+
+ Any subsequent calls to this method will supersede any previously set
+ allowlist values. Calling this method with an empty array will allow
+ any service UUIDs to be used.
+
+ The default value is an empty array.
+
+ Possible errors:
+
+ :org.bluez.Error.InvalidArguments:
+ :org.bluez.Error.Failed:
diff --git a/doc/org.bluez.AdminPolicyStatus.rst b/doc/org.bluez.AdminPolicyStatus.rst
new file mode 100644
index 000000000000..ad2dc58dec0a
--- /dev/null
+++ b/doc/org.bluez.AdminPolicyStatus.rst
@@ -0,0 +1,49 @@
+===========================
+org.bluez.AdminPolicyStatus
+===========================
+
+-----------------------------------------------
+BlueZ D-Bus AdminPolicyStatus API documentation
+-----------------------------------------------
+
+:Version: BlueZ
+:Date: October 2023
+:Manual section: 5
+:Manual group: Linux System Administration
+
+Description
+===========
+
+Interface AdminPolicyStatus1 provides readonly properties to indicate the
+current values of admin policy affecting the Adapter and Device objects.
+
+Interface
+=========
+
+Adapter
+-------
+
+:Service: org.bluez
+:Interface: org.bluez.AdminPolicyStatus1 [experimental]
+:Object path: [variable prefix]/{hci0,hci1,...}
+
+Device
+------
+
+:Service: org.bluez
+:Interface: org.bluez.AdminPolicyStatus1 [experimental]
+:Object path: [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX
+
+Properties
+----------
+
+array{string} ServiceAllowList [readonly, adapter-only]
+```````````````````````````````````````````````````````
+
+ Current value of service allow list.
+
+bool IsAffectedByPolicy [readonly, device-only]
+```````````````````````````````````````````````
+
+ Indicate if there is any auto-connect profile in this device is not
+ allowed by admin policy.
--
2.41.0
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=791597
---Test result---
Test Summary:
CheckPatch PASS 5.17 seconds
GitLint FAIL 3.88 seconds
BuildEll PASS 28.05 seconds
BluezMake PASS 786.38 seconds
MakeCheck PASS 11.55 seconds
MakeDistcheck PASS 165.95 seconds
CheckValgrind PASS 260.49 seconds
CheckSmatch PASS 353.50 seconds
bluezmakeextell PASS 108.82 seconds
IncrementalBuild PASS 7338.07 seconds
ScanBuild PASS 1045.91 seconds
Details
##############################
Test: GitLint - FAIL
Desc: Run gitlint
Output:
[v2,10/11] doc/advertisement-monitor-api: Rename to org.bluez.AdvertisementMonitor*.rst
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: T1 Title exceeds max length (87>80): "[v2,10/11] doc/advertisement-monitor-api: Rename to org.bluez.AdvertisementMonitor*.rst"
---
Regards,
Linux Bluetooth
Hello:
This series was applied to bluetooth/bluez.git (master)
by Luiz Augusto von Dentz <[email protected]>:
On Mon, 9 Oct 2023 16:29:23 -0700 you wrote:
> From: Luiz Augusto von Dentz <[email protected]>
>
> This renames adapter-api.txt to org.bluez.Adapter.rst and generate a
> manpage org.bluez.Adapter.5.
> ---
> Makefile.am | 8 +-
> doc/adapter-api.txt | 373 ----------------------------------
> doc/org.bluez.Adapter.rst | 412 ++++++++++++++++++++++++++++++++++++++
> 3 files changed, 416 insertions(+), 377 deletions(-)
> delete mode 100644 doc/adapter-api.txt
> create mode 100644 doc/org.bluez.Adapter.rst
Here is the summary with links:
- [v2,01/11] doc/adapter-api: Rename to org.bluez.Adapter.rst
https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=6f7effa4534f
- [v2,02/11] doc/device-api: Rename to org.bluez.Device.rst
https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=359132ba897e
- [v2,03/11] doc/agent-api: Rename to org.bluez.Agent{Manager}.rst
https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=42e2934c2356
- [v2,04/11] doc/profile-api: Rename to org.bluez.Profile{Manager}.rst
https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=c5729e61b150
- [v2,05/11] doc/network-api: Rename to org.bluez.Network{Server}.rst
https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=6481b9095b34
- [v2,06/11] doc/input-api: Rename to org.bluez.Input.rst
https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=cfc76016b4d4
- [v2,07/11] doc/advertising-api: Rename to org.bluez.LEAdvertis*.rst
https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=dec59a07fb11
- [v2,08/11] doc/gatt-api: Rename to org.bluez.Gatt*.rst
https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=c6c412d6ccbc
- [v2,09/11] doc/battery-api: Rename to org.bluez.Battery*.rst
https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=cba68babe1e6
- [v2,10/11] doc/advertisement-monitor-api: Rename to org.bluez.AdvertisementMonitor*.rst
https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=87151d1904ad
- [v2,11/11] doc/admin-policy-api: Rename to org.bluez.AdminPolicy*.rst
https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=ee27626c7a06
You are awesome, thank you!
--
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html