doc: Add cross-references between bluetoothctl and D-Bus API docs
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
- v3 Latest37 patches 1 replyApplied
- v235 patches 1 replySuperseded
- 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
Reviews trailers per patch
No Reviewed-by, Acked-by or Tested-by trailers for v3 yet.
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