From: Gerhard Sittig <redacted>
Date: Wed, 15 Mar 2023 23:35:20 +0000 (+0100)
Subject: serial_bt: update comments on conn=bt/... parameters
X-Git-Url: https://sigrok.org/gitaction?a=commitdiff_plain;h=ee617d622c114bb3d3b5021a4f03a34c7a925bf8;p=libsigrok.git

serial_bt: update comments on conn=bt/... parameters

Commit 0e4a85a9254c added support for parameters that follow the BT/BLE
remote address in conn= specs. Update developer comments near the parse
routine.
---

diff --git a/src/serial_bt.c b/src/serial_bt.c
index a851dad8..f40cd736 100644
--- a/src/serial_bt.c
+++ b/src/serial_bt.c
@@ -125,14 +125,16 @@ static const char *conn_name_text(enum ser_bt_conn_t type)
  * - The next field is the remote device's address, either separated
  *   by colons or dashes or spaces, or not separated at all.
  * - Other parameters (RFCOMM channel, notify handles and write values)
- *   get derived from the connection type. A future implementation may
- *   accept more fields, but the syntax is yet to get developed.
+ *   get derived from the connection type.
+ * - More fields after the remote address are options which override
+ *   builtin defaults (RFCOMM channels, BLE handles, etc).
  *
  * Supported formats resulting from these rules:
- *   bt/<conn>/<addr>
+ *   bt/<conn>/<addr>[/<param>]...
  *
  * Examples:
  *   bt/rfcomm/11-22-33-44-55-66
+ *   bt/rfcomm/11-22-33-44-55-66/channel=2
  *   bt/ble122/88:6b:12:34:56:78
  *   bt/cc254x/0123456789ab
  *