Skip to content

Commit 5caa2a4

Browse files
kartbenMaureenHelm
authored andcommitted
doc: Bluetooth: update file references to use zephyr_file role
Source tree layout description should use :zephyr_file: since it creates hyperlinks to GitHub and, more importantly, the references are validated by the doc build so it guarantees they don't risk going stale. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
1 parent 08ff08d commit 5caa2a4

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

‎doc/connectivity/bluetooth/bluetooth-arch.rst‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -182,35 +182,35 @@ Source tree layout
182182

183183
The stack is split up as follows in the source tree:
184184

185-
``subsys/bluetooth/host``
185+
:zephyr_file:`subsys/bluetooth/host`
186186
:ref:`The host stack <bluetooth_le_host>`. This is where the HCI command and
187187
event handling as well as connection tracking happens. The implementation of
188188
the core protocols such as L2CAP, ATT, and SMP is also here.
189189

190-
``subsys/bluetooth/controller``
190+
:zephyr_file:`subsys/bluetooth/controller`
191191
:ref:`Bluetooth LE Controller <bluetooth-ctlr-arch>` implementation.
192192
Implements the controller-side of HCI, the Link Layer as well as access to the
193193
radio transceiver.
194194

195-
``include/zephyr/bluetooth/``
195+
:zephyr_file:`include/zephyr/bluetooth/`
196196
:ref:`Public API <bluetooth_api>` header files. These are the header files
197197
applications need to include in order to use Bluetooth functionality.
198198

199-
``drivers/bluetooth/``
199+
:zephyr_file:`drivers/bluetooth/`
200200
HCI transport drivers. Every HCI transport needs its own driver. For example,
201201
the two common types of UART transport protocols (3-Wire and 5-Wire)
202202
have their own drivers.
203203

204-
``samples/bluetooth/``
204+
:zephyr_file:`samples/bluetooth/`
205205
:zephyr:code-sample-category:`Sample Bluetooth code <bluetooth>`. This is a good reference to
206206
get started with Bluetooth application development.
207207

208-
``tests/bluetooth/``
208+
:zephyr_file:`tests/bluetooth/`
209209
Test applications. These applications are used to verify the
210210
functionality of the Bluetooth stack, but are not necessary the best
211-
source for sample code (see ``samples/bluetooth`` instead).
211+
source for sample code (see :zephyr_file:`samples/bluetooth` instead).
212212

213-
``doc/connectivity/bluetooth/``
213+
:zephyr_file:`doc/connectivity/bluetooth/`
214214
Extra documentation, such as PICS documents.
215215

216216
.. _Bluetooth Specification: https://www.bluetooth.com/specifications/bluetooth-core-specification

0 commit comments

Comments
 (0)