Skip to content

doc: Add cross-references between bluetoothctl and D-Bus API docs

Luiz Augusto von Dentz linux-bluetooth 3 versions – Applied

Status from this message: This series was applied to bluetooth/bluez.git (master)

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v3 Latest37 patches 1 replyApplied
  2. v235 patches 1 replySuperseded
  3. v115 patches 1 replySuperseded

Changes in v3 from the cover letter

- Add Examples for properties:
- org.bluez.Adapter: Alias, Powered, Discoverable, Pairable, DiscoverableTimeout
- org.bluez.Device: Alias, PreferredBearer (Trusted, Blocked, WakeAllowed were already present)
- org.bluez.MediaPlayer: Equalizer, Repeat, Shuffle, Scan
- org.bluez.MediaTransport: Volume
- Add Examples for additional methods:
- org.bluez.AdvertisementMonitorManager: RegisterMonitor, UnregisterMonitor
- org.bluez.GattDescriptor: ReadValue, WriteValue
- org.bluez.MediaFolder: Search, ListItems, ChangeFolder
- org.bluez.MediaItem: Play, AddtoNowPlaying
- Add new documentation files:
- org.bluez.MediaFolder: Add Used by reference and Examples
- org.bluez.MediaItem: Add Used by reference and Examples

Patches in v3 Applied

#Subject and filesSizeRepliesApplied
1/37doc/bluetoothctl: Add :Uses: fields and document argumentsdoc/bluetoothctl.rst+223 -271 reply
2/37doc/bluetoothctl-mgmt: Add :Uses: fields and document argumentsdoc/bluetoothctl-mgmt.rst+738 -50 replies
3/37doc/bluetoothctl-admin: Add :Uses: fields and document argumentsdoc/bluetoothctl-admin.rst+26 -20 replies
4/37doc/bluetoothctl-advertise: Add :Uses: fields and document argumentsdoc/bluetoothctl-advertise.rst+342 -140 replies
5/37doc/bluetoothctl-assistant: Add :Uses: fields and document argumentsdoc/bluetoothctl-assistant.rst+21 -30 replies
6/37doc/bluetoothctl-bredr: Add :Uses: fields and document argumentsdoc/bluetoothctl-bredr.rst+21 -40 replies
7/37doc/bluetoothctl-endpoint: Add :Uses: fields and document argumentsdoc/bluetoothctl-endpoint.rst+145 -720 replies
8/37doc/bluetoothctl-gatt: Add :Uses: fields and document argumentsdoc/bluetoothctl-gatt.rst+244 -50 replies
9/37doc/bluetoothctl-hci: Add :Uses: fields and document argumentsdoc/bluetoothctl-hci.rst+99 -130 replies
10/37doc/bluetoothctl-le: Add :Uses: fields and document argumentsdoc/bluetoothctl-le.rst+22 -40 replies
11/37doc/bluetoothctl-monitor: Add :Uses: fields and document argumentsdoc/bluetoothctl-monitor.rst+77 -20 replies
12/37doc/bluetoothctl-player: Add :Uses: fields and document argumentsdoc/bluetoothctl-player.rst+118 -00 replies
13/37doc/bluetoothctl-scan: Add :Uses: fields and document argumentsdoc/bluetoothctl-scan.rst+122 -40 replies
14/37doc/bluetoothctl-telephony: Add :Uses: fields and document argumentsdoc/bluetoothctl-telephony.rst+71 -40 replies
15/37doc/bluetoothctl-transport: Add :Uses: fields and document argumentsdoc/bluetoothctl-transport.rst+77 -10 replies
16/37doc/org.bluez.Adapter: Add Used by reference and Examplesdoc/org.bluez.Adapter.rst+41 -00 replies
17/37doc/org.bluez.AdminPolicySet: Add Used by reference and Examplesdoc/org.bluez.AdminPolicySet.rst+5 -00 replies
18/37doc/org.bluez.AdminPolicyStatus: Add Used by referencedoc/org.bluez.AdminPolicyStatus.rst+1 -00 replies
19/37doc/org.bluez.AdvertisementMonitor: Add Used by referencedoc/org.bluez.AdvertisementMonitor.rst+1 -00 replies
20/37doc/org.bluez.AdvertisementMonitorManager: Add Used by referencedoc/org.bluez.AdvertisementMonitorManager.rst+9 -00 replies
21/37doc/org.bluez.AgentManager: Add Used by reference and Examplesdoc/org.bluez.AgentManager.rst+9 -00 replies
22/37doc/org.bluez.Call: Add Used by reference and Examplesdoc/org.bluez.Call.rst+9 -00 replies
23/37doc/org.bluez.Device: Add Used by reference and Examplesdoc/org.bluez.Device.rst+39 -00 replies
24/37doc/org.bluez.GattCharacteristic: Add Used by reference and Examplesdoc/org.bluez.GattCharacteristic.rst+21 -00 replies
25/37doc/org.bluez.GattDescriptor: Add Used by referencedoc/org.bluez.GattDescriptor.rst+9 -00 replies
26/37doc/org.bluez.GattManager: Add Used by reference and Examplesdoc/org.bluez.GattManager.rst+9 -00 replies
27/37doc/org.bluez.GattService: Add Used by referencedoc/org.bluez.GattService.rst+1 -00 replies
28/37doc/org.bluez.LEAdvertisement: Add Used by referencedoc/org.bluez.LEAdvertisement.rst+1 -00 replies
29/37doc/org.bluez.LEAdvertisingManager: Add Used by reference and Examplesdoc/org.bluez.LEAdvertisingManager.rst+5 -00 replies
30/37doc/org.bluez.Media: Add Used by referencedoc/org.bluez.Media.rst+9 -00 replies
31/37doc/org.bluez.MediaAssistant: Add Used by reference and Examplesdoc/org.bluez.MediaAssistant.rst+5 -00 replies
32/37doc/org.bluez.MediaEndpoint: Add Used by referencedoc/org.bluez.MediaEndpoint.rst+5 -00 replies
33/37doc/org.bluez.MediaPlayer: Add Used by reference and Examplesdoc/org.bluez.MediaPlayer.rst+45 -00 replies
34/37doc/org.bluez.MediaTransport: Add Used by reference and Examplesdoc/org.bluez.MediaTransport.rst+21 -00 replies
35/37doc/org.bluez.Telephony: Add Used by reference and Examplesdoc/org.bluez.Telephony.rst+9 -00 replies
36/37doc/org.bluez.MediaFolder: Add Used by reference and Examplesdoc/org.bluez.MediaFolder.rst+13 -00 replies
37/37doc/org.bluez.MediaItem: Add Used by reference and Examplesdoc/org.bluez.MediaItem.rst+9 -00 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v3 yet.

Read the v3 thread

Cover letter [PATCH BlueZ v3 00/37] doc: Add cross-references between bluetoothctl and D-Bus API docs

From: Luiz Augusto von Dentz <[email protected]>

This patch series adds cross-references between bluetoothctl man pages and D-Bus API documentation to improve discoverability and help users navigate between the command-line interface and the underlying D-Bus APIs.

Changes include:

1. bluetoothctl documentation (patches 01-15):
- Add :Uses: fields linking commands to D-Bus interfaces they use
- Document command arguments with descriptions and examples

2. D-Bus API documentation (patches 16-37):
- Add :Used by: fields linking interfaces to bluetoothctl man pages
- Add Examples: sections showing corresponding bluetoothctl commands for both methods and properties

Changes in v3:
- Add Examples for properties:
- org.bluez.Adapter: Alias, Powered, Discoverable, Pairable, DiscoverableTimeout
- org.bluez.Device: Alias, PreferredBearer (Trusted, Blocked, WakeAllowed were already present)
- org.bluez.MediaPlayer: Equalizer, Repeat, Shuffle, Scan
- org.bluez.MediaTransport: Volume
- Add Examples for additional methods:
- org.bluez.AdvertisementMonitorManager: RegisterMonitor, UnregisterMonitor
- org.bluez.GattDescriptor: ReadValue, WriteValue
- org.bluez.MediaFolder: Search, ListItems, ChangeFolder
- org.bluez.MediaItem: Play, AddtoNowPlaying
- Add new documentation files:
- org.bluez.MediaFolder: Add Used by reference and Examples
- org.bluez.MediaItem: Add Used by reference and Examples

Luiz Augusto von Dentz (37):
doc/bluetoothctl: Add :Uses: fields and document arguments doc/bluetoothctl-mgmt: Add :Uses: fields and document arguments doc/bluetoothctl-admin: Add :Uses: fields and document arguments doc/bluetoothctl-advertise: Add :Uses: fields and document arguments doc/bluetoothctl-assistant: Add :Uses: fields and document arguments doc/bluetoothctl-bredr: Add :Uses: fields and document arguments doc/bluetoothctl-endpoint: Add :Uses: fields and document arguments doc/bluetoothctl-gatt: Add :Uses: fields and document arguments doc/bluetoothctl-hci: Add :Uses: fields and document arguments doc/bluetoothctl-le: Add :Uses: fields and document arguments doc/bluetoothctl-monitor: Add :Uses: fields and document arguments doc/bluetoothctl-player: Add :Uses: fields and document arguments doc/bluetoothctl-scan: Add :Uses: fields and document arguments doc/bluetoothctl-telephony: Add :Uses: fields and document arguments doc/bluetoothctl-transport: Add :Uses: fields and document arguments doc/org.bluez.Adapter: Add Used by reference and Examples doc/org.bluez.AdminPolicySet: Add Used by reference and Examples doc/org.bluez.AdminPolicyStatus: Add Used by reference doc/org.bluez.AdvertisementMonitor: Add Used by reference doc/org.bluez.AdvertisementMonitorManager: Add Used by reference doc/org.bluez.AgentManager: Add Used by reference and Examples doc/org.bluez.Call: Add Used by reference and Examples doc/org.bluez.Device: Add Used by reference and Examples doc/org.bluez.GattCharacteristic: Add Used by reference and Examples doc/org.bluez.GattDescriptor: Add Used by reference doc/org.bluez.GattManager: Add Used by reference and Examples doc/org.bluez.GattService: Add Used by reference doc/org.bluez.LEAdvertisement: Add Used by reference doc/org.bluez.LEAdvertisingManager: Add Used by reference and Examples doc/org.bluez.Media: Add Used by reference doc/org.bluez.MediaAssistant: Add Used by reference and Examples doc/org.bluez.MediaEndpoint: Add Used by reference doc/org.bluez.MediaPlayer: Add Used by reference and Examples doc/org.bluez.MediaTransport: Add Used by reference and Examples doc/org.bluez.Telephony: Add Used by reference and Examples doc/org.bluez.MediaFolder: Add Used by reference and Examples doc/org.bluez.MediaItem: Add Used by reference and Examples

 doc/bluetoothctl-admin.rst                    |  28 +-
 doc/bluetoothctl-advertise.rst                | 356 ++++++++-
 doc/bluetoothctl-assistant.rst                |  24 +-
 doc/bluetoothctl-bredr.rst                    |  25 +-
 doc/bluetoothctl-endpoint.rst                 | 217 +++--
 doc/bluetoothctl-gatt.rst                     | 249 +++++-
 doc/bluetoothctl-hci.rst                      | 112 ++-
 doc/bluetoothctl-le.rst                       |  26 +-
 doc/bluetoothctl-mgmt.rst                     | 743 +++++++++++++++++-
 doc/bluetoothctl-monitor.rst                  |  79 +-
 doc/bluetoothctl-player.rst                   | 118 +++
 doc/bluetoothctl-scan.rst                     | 126 ++-
 doc/bluetoothctl-telephony.rst                |  75 +-
 doc/bluetoothctl-transport.rst                |  78 +-
 doc/bluetoothctl.rst                          | 250 +++++-
 doc/org.bluez.Adapter.rst                     |  41 +
 doc/org.bluez.AdminPolicySet.rst              |   5 +
 doc/org.bluez.AdminPolicyStatus.rst           |   1 +
 doc/org.bluez.AdvertisementMonitor.rst        |   1 +
 doc/org.bluez.AdvertisementMonitorManager.rst |   9 +
 doc/org.bluez.AgentManager.rst                |   9 +
 doc/org.bluez.Call.rst                        |   9 +
 doc/org.bluez.Device.rst                      |  39 +
 doc/org.bluez.GattCharacteristic.rst          |  21 +
 doc/org.bluez.GattDescriptor.rst              |   9 +
 doc/org.bluez.GattManager.rst                 |   9 +
 doc/org.bluez.GattService.rst                 |   1 +
 doc/org.bluez.LEAdvertisement.rst             |   1 +
 doc/org.bluez.LEAdvertisingManager.rst        |   5 +
 doc/org.bluez.Media.rst                       |   9 +
 doc/org.bluez.MediaAssistant.rst              |   5 +
 doc/org.bluez.MediaEndpoint.rst               |   5 +
 doc/org.bluez.MediaFolder.rst                 |  13 +
 doc/org.bluez.MediaItem.rst                   |   9 +
 doc/org.bluez.MediaPlayer.rst                 |  45 ++
 doc/org.bluez.MediaTransport.rst              |  21 +
 doc/org.bluez.Telephony.rst                   |   9 +
 37 files changed, 2622 insertions(+), 160 deletions(-)
Signature · 1 line
2.52.0