[BlueZ,1/1] client: Add bluetoothctl-assistant.1 man page

Commit Message

Iulia Tanasescu Aug. 20, 2024, 11:31 a.m. UTC

This adds bluetoothctl-assistant.rst which is then converted to
bluetoothctl-assistant.1 using rst2man.
---
 Makefile.tools                    |  6 ++-
 client/bluetoothctl-assistant.rst | 63 +++++++++++++++++++++++++++++++
 client/bluetoothctl.rst           |  5 +++
 3 files changed, 72 insertions(+), 2 deletions(-)
 create mode 100644 client/bluetoothctl-assistant.rst

Comments

[e-mail] Aug. 20, 2024, 1:07 p.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=881314

---Test result---

Test Summary:
CheckPatch                    PASS      0.38 seconds
GitLint                       PASS      0.30 seconds
BuildEll                      PASS      25.11 seconds
BluezMake                     PASS      1777.30 seconds
MakeCheck                     FAIL      13.65 seconds
MakeDistcheck                 FAIL      162.29 seconds
CheckValgrind                 FAIL      255.71 seconds
CheckSmatch                   PASS      362.28 seconds
bluezmakeextell               PASS      123.95 seconds
IncrementalBuild              PASS      1545.75 seconds
ScanBuild                     PENDING   1099.97 seconds

Details
##############################
Test: MakeCheck - FAIL
Desc: Run Bluez Make Check
Output:

make[3]: *** [Makefile:11766: test-suite.log] Error 1
make[2]: *** [Makefile:11874: check-TESTS] Error 2
make[1]: *** [Makefile:12303: check-am] Error 2
make: *** [Makefile:12305: check] Error 2
##############################
Test: MakeDistcheck - FAIL
Desc: Run Bluez Make Distcheck
Output:

Package cups was not found in the pkg-config search path.
Perhaps you should add the directory containing `cups.pc'
to the PKG_CONFIG_PATH environment variable
No package 'cups' found
make[4]: *** [Makefile:11766: test-suite.log] Error 1
make[3]: *** [Makefile:11874: check-TESTS] Error 2
make[2]: *** [Makefile:12303: check-am] Error 2
make[1]: *** [Makefile:12305: check] Error 2
make: *** [Makefile:12226: distcheck] Error 1
##############################
Test: CheckValgrind - FAIL
Desc: Run Bluez Make Check with Valgrind
Output:

tools/mgmt-tester.c: In function ‘main’:
tools/mgmt-tester.c:12725:5: note: variable tracking size limit exceeded with ‘-fvar-tracking-assignments’, retrying without
12725 | int main(int argc, char *argv[])
      |     ^~~~
make[3]: *** [Makefile:11766: test-suite.log] Error 1
make[2]: *** [Makefile:11874: check-TESTS] Error 2
make[1]: *** [Makefile:12303: check-am] Error 2
make: *** [Makefile:12305: check] Error 2
##############################
Test: ScanBuild - PENDING
Desc: Run Scan Build
Output:



---
Regards,
Linux Bluetooth

Patch

diff --git a/Makefile.tools b/Makefile.tools
index f4f9e82dc..5b9034078 100644
--- a/Makefile.tools
+++ b/Makefile.tools
@@ -349,7 +349,8 @@  man_MANS += tools/rctest.1 tools/l2ping.1 tools/btattach.1 tools/isotest.1 \
 		client/bluetoothctl-monitor.1 client/bluetoothctl-admin.1 \
 		client/bluetoothctl-advertise.1 client/bluetoothctl-endpoint.1 \
 		client/bluetoothctl-gatt.1 client/bluetoothctl-player.1 \
-		client/bluetoothctl-scan.1 client/bluetoothctl-transport.1
+		client/bluetoothctl-scan.1 client/bluetoothctl-transport.1 \
+		client/bluetoothctl-assistant.1
 
 endif
 
@@ -481,7 +482,8 @@  manual_pages += tools/hciattach.1 tools/hciconfig.1 \
 			client/bluetoothctl-gatt.1 \
 			client/bluetoothctl-player.1 \
 			client/bluetoothctl-scan.1 \
-			client/bluetoothctl-transport.1
+			client/bluetoothctl-transport.1 \
+			client/bluetoothctl-assistant.1
 
 if HID2HCI
 udevdir = $(UDEV_DIR)
diff --git a/client/bluetoothctl-assistant.rst b/client/bluetoothctl-assistant.rst
new file mode 100644
index 000000000..b4f7d039b
--- /dev/null
+++ b/client/bluetoothctl-assistant.rst
@@ -0,0 +1,63 @@ 
+======================
+bluetoothctl-assistant
+======================
+
+-----------------
+Assistant Submenu
+-----------------
+
+:Version: BlueZ
+:Copyright: Free use of this software is granted under ther terms of the GNU
+            Lesser General Public Licenses (LGPL).
+:Date: August 2024
+:Manual section: 1
+:Manual group: Linux System Administration
+
+SYNOPSIS
+========
+
+**bluetoothctl** [--options] [assistant.commands]
+
+Assistant Commands
+==================
+
+push
+----
+
+Send stream information to peer.
+
+This command is used by a BAP Broadcast Assistant to send
+information about a broadcast stream to a peer BAP Scan
+Delegator.
+
+The information is sent via a GATT Write Command for the
+BASS Broadcast Audio Scan Control Point characteristic.
+
+After issuing the command, the user is prompted to enter
+stream metadata LTVs to send to the peer. If the auto
+option is chosen, the Broadcast Assistant will send the
+default metadata discovered about the stream. Otherwise,
+the default metadata will be overwritten by the LTVs
+entered by the user.
+
+If the stream is encrypted, the user will also be prompted
+to enter the Broadcast Code. This is a 16 bytes array which
+will be used by the peer to decrypt the stream. If the auto
+value is chosen, a zero filled array will be sent to the peer.
+Otherwise, the bytes entered by the user will be sent.
+
+:Usage: **# push <assistant>**
+:Example: | **# push /org/bluez/hci0/src_05_1F_EE_F3_F8_7D/dev_00_60_37_31_7E_3F/bis1**
+          | **[Assistant] Enter Metadata (auto/value): 0x03 0x02 0x04 0x00**
+          | **[Assistant] Enter Broadcast Code (auto/value): 0x01 0x02 0x68 0x05 0x53
+                          0xf1 0x41 0x5a 0xa2 0x65 0xbb 0xaf 0xc6 0xea 0x03 0xb8**
+
+RESOURCES
+=========
+
+http://www.bluez.org
+
+REPORTING BUGS
+==============
+
[e-mail]
diff --git a/client/bluetoothctl.rst b/client/bluetoothctl.rst
index 7e00ae3ac..7454c1d08 100644
--- a/client/bluetoothctl.rst
+++ b/client/bluetoothctl.rst
@@ -334,6 +334,11 @@  Management Submenu
 
 See **bluetoothctl-mgmt(1)**
 
+Assistant Submenu
+==================
+
+See **bluetoothctl-assistant(1)**
+
 AUTOMATION
 ==========
 Two common ways to automate the tool are to use Here Docs or the program expect.