-
Notifications
You must be signed in to change notification settings - Fork 6.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
samples: bluetooth: use zephyr:code-sample directive #77760
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,8 @@ | ||
.. zephyr:code-sample:: bluetooth_bap_broadcast_sink | ||
:name: Bluetooth: Broadcast Audio Sink | ||
:name: Broadcast Audio Sink | ||
:relevant-api: bluetooth | ||
|
||
Bluetooth: Broadcast Audio Sink | ||
Use LE Audio Broadcast Sink functionality. | ||
Comment on lines
+2
to
+5
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think I'll follow up with a name update PR later - I think several of our LE audio samples could benefit from better names and descriptions, but let's not muddy this PR too much with that :) There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, this would be awesome. It's true that a lot of the names and descriptions are very "content-free" right now and not all that helpful. Hopefully the follow-up PR will be much easier to implement once the directives will already be there :) There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. #78094 :) |
||
|
||
Overview | ||
******** | ||
|
@@ -53,7 +53,7 @@ If you prefer to only build the application core image, you can do so by doing i | |
:goals: build | ||
|
||
In that case you can pair this application core image with the | ||
:ref:`hci_ipc sample <bluetooth-hci-ipc-sample>` | ||
:zephyr:code-sample:`bluetooth_hci_ipc` sample | ||
:zephyr_file:`samples/bluetooth/hci_ipc/nrf5340_cpunet_iso-bt_ll_sw_split.conf` configuration. | ||
|
||
Building for a simulated nrf5340bsim | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why is one prefixed with
bluetooth_
and the other withble_
? Don't think the beacon sample runs on a classic stack.I would prefer
bluetooth_classic_xx
for classic samples, and the rest is assumed to be LE.What do you think?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's a few more with the same inconsistency. Also some that is prefixed with
_
, and even one that isbluetooth_bt
:DAre we planning on using explicit tags, or should we attempt to shorten them at bit? e.g.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would prefer long names for the documentation references. Shortening the filenames/path should be ok. Although i hope people have shell completion
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The simplest route might be to just use the same IDs as the folder names?
Related: is it time to introduce some subfolders underneath
samples/bluetooth
? It's starting to get really packed in there :)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
#64443 :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure, so we can have
bluetooth
prefix for all BT samples, and then, when we do the above move, we can have them likebluetooth_audio_xxx
,bluetooth_mesh_xxx