Skip to content

Commit 3b97d54

Browse files
gmarullnordicjm
authored andcommitted
doc: nrf: update references to Zephyr documentation
Update some references with their new id. Note that most samples now require the usage of the Zephyr Sphinx domain, enabled in this patch as well. Signed-off-by: Gerard Marull-Paretas <[email protected]>
1 parent ef285bf commit 3b97d54

File tree

25 files changed

+71
-70
lines changed

25 files changed

+71
-70
lines changed

applications/nrf5340_audio/doc/firmware_architecture.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ Synchronization module flow
263263
The received audio data in the I2S-based firmware devices follows the following path:
264264

265265
1. The LE Audio Controller Subsystem for nRF53 running on the network core receives the compressed audio data.
266-
#. The controller subsystem sends the audio data to the Zephyr Bluetooth LE host similarly to the :ref:`zephyr:bluetooth-hci-rpmsg-sample` sample.
266+
#. The controller subsystem sends the audio data to the Zephyr Bluetooth LE host similarly to the :ref:`zephyr:bluetooth-hci-ipc-sample` sample.
267267
#. The host sends the data to the stream control module.
268268
#. The data is sent to a FIFO buffer.
269269
#. The data is sent from the FIFO buffer to the :file:`audio_datapath.c` synchronization module.

doc/nrf/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@
4848
"zephyr.external_content",
4949
"zephyr.doxyrunner",
5050
"zephyr.link-roles",
51+
"zephyr.domain",
5152
"sphinx_tabs.tabs",
5253
"software_maturity_table",
5354
"sphinx_togglebutton",

doc/nrf/device_guides/working_with_nrf/nrf52/developing.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ Here is an example of how you can build for the :ref:`peripheral_lbs` sample:
7878
west build -b *build_target* -- -DCONFIG_BOOTLOADER_MCUBOOT=y -DCONFIG_NCS_SAMPLE_MCUMGR_BT_OTA_DFU=y
7979
8080
When you connect to the device after the build has completed and the firmware has been programmed to it, the SMP Service is enabled with the ``UUID 8D53DC1D-1DB7-4CD3-868B-8A527460AA84``.
81-
If you want to add SMP Service to advertising data, refer to the :ref:`zephyr:smp_svr_sample`.
81+
If you want to add SMP Service to advertising data, refer to the :zephyr:code-sample:`smp-svr`.
8282

8383
.. fota_upgrades_over_ble_additional_information_end
8484
@@ -180,11 +180,11 @@ To perform a FOTA update, complete the following steps:
180180
FOTA update sample
181181
==================
182182

183-
The :ref:`zephyr:smp_svr_sample` demonstrates how to set up your project to support FOTA updates.
183+
The :zephyr:code-sample:`smp-svr` demonstrates how to set up your project to support FOTA updates.
184184

185185
The sample documentation is from the Zephyr project and is incompatible with the :ref:`ug_multi_image`.
186186
When working in the |NCS| environment, ignore the part of the sample documentation that describes the building and programming steps.
187-
In |NCS|, you can build and program the :ref:`zephyr:smp_svr_sample` as any other sample using the following commands:
187+
In |NCS|, you can build and program the :zephyr:code-sample:`smp-svr` as any other sample using the following commands:
188188

189189
.. parsed-literal::
190190
:class: highlight

doc/nrf/device_guides/working_with_nrf/nrf53/nrf5340.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ Bluetooth Low Energy
161161

162162
* - Network core
163163
- Application core
164-
* - :ref:`zephyr:bluetooth-hci-rpmsg-sample`
164+
* - :ref:`zephyr:bluetooth-hci-ipc-sample`
165165
- | :ref:`Bluetooth Low Energy samples <ble_samples>`
166166
| :ref:`Bluetooth samples in Zephyr <zephyr:bluetooth-samples>`
167167
* - :ref:`ble_rpc_host` (supported for development)
@@ -177,7 +177,7 @@ Split Controller and Host
177177

178178
When splitting the Bluetooth LE Controller and the Host, run the Bluetooth LE Controller on the network core and the host part of the Bluetooth LE stack and the application logic on the application core.
179179

180-
For the network core, the |NCS| provides the :ref:`zephyr:bluetooth-hci-rpmsg-sample` sample.
180+
For the network core, the |NCS| provides the :ref:`zephyr:bluetooth-hci-ipc-sample` sample.
181181
This Zephyr sample is designed specifically to enable the Bluetooth LE Controller functionality on a remote MCU using the `RPMsg Messaging Protocol`_ as a transport for Bluetooth HCI.
182182
The sample implements the RPMsg transport using the `OpenAMP`_ library to communicate with a Bluetooth Host stack that runs on a separate core (in this case, the nRF5340 application core).
183183

@@ -257,7 +257,7 @@ When using Thread or Zigbee in parallel with Bluetooth LE, run the low-level rad
257257
Bluetooth LE and IEEE 802.15.4 multiprotocol architecture in multicore SoC
258258

259259
For the network core, the |NCS| provides the :ref:`multiprotocol-rpmsg-sample` sample.
260-
It is a combination of the :ref:`zephyr:bluetooth-hci-rpmsg-sample` sample (for Bluetooth LE) and the :ref:`zephyr:nrf-ieee802154-rpmsg-sample` sample (for IEEE 802.15.4).
260+
It is a combination of the :ref:`zephyr:bluetooth-hci-ipc-sample` sample (for Bluetooth LE) and the :ref:`zephyr:nrf-ieee802154-rpmsg-sample` sample (for IEEE 802.15.4).
261261
This means that it enables both the Bluetooth LE Controller and the nRF IEEE 802.15.4 radio driver and simultaneously exposes the functionality of both stacks to the application core using the `RPMsg Messaging Protocol`_.
262262
Separate RPMsg endpoints are used to obtain independent inter-core connections for each stack.
263263

@@ -354,7 +354,7 @@ The combination of these options determines which (if any) sample is included in
354354
- Child image sample for the network core
355355
- Child image sample for the application core
356356
* - :kconfig:option:`CONFIG_BT_HCI_IPC`
357-
- :ref:`zephyr:bluetooth-hci-rpmsg-sample`
357+
- :ref:`zephyr:bluetooth-hci-ipc-sample`
358358
- ---
359359
* - :kconfig:option:`CONFIG_NRF_802154_SER_HOST`
360360
- :ref:`zephyr:nrf-ieee802154-rpmsg-sample`

doc/nrf/device_guides/working_with_nrf/nrf70/gs.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -250,8 +250,8 @@ Testing the LEDs and buttons in the nRF7002 DK
250250

251251
The following samples allow you to test if the buttons (or switches) and LEDs on the development kit are working properly with |NCS|:
252252

253-
* :ref:`blinky-sample`
254-
* :ref:`button-sample`
253+
* :zephyr:code-sample:`blinky`
254+
* :zephyr:code-sample:`button`
255255

256256
Build and flash the samples to make sure |NCS| is running correctly on your development kit.
257257
For the button and LED definitions, see the :file:`boards/arm/nrf7002dk_nrf5340/nrf5340_cpuapp_common.dts` file.

doc/nrf/libraries/bluetooth_services/services/dfu_smp.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This module implements a Simple Management Protocol (SMP) Service Client that ca
1111
SMP is a basic transfer encoding for use with the `mcumgr`_ management protocol.
1212
See `SMP over Bluetooth`_ for the service specification.
1313

14-
The SMP Client module can be used to interact with Zephyr's :ref:`zephyr:smp_svr_sample`.
14+
The SMP Client module can be used to interact with Zephyr's :zephyr:code-sample:`smp-svr`.
1515

1616
The SMP Client implements only the service.
1717
It does not provide any functionality to process or interpret SMP commands and responses.
@@ -49,12 +49,12 @@ Usage
4949
MTU negotiation
5050
===============
5151

52-
The current DFU SMP Server implementation in the :ref:`zephyr:smp_svr_sample` requires the whole command to be sent in one transfer.
52+
The current DFU SMP Server implementation in the :zephyr:code-sample:`smp-svr` requires the whole command to be sent in one transfer.
5353
For most operations, this requires a bigger MTU size than the default one.
5454
This requires MTU negotiation in the MTU exchange process (see :c:func:`bt_gatt_exchange_mtu`).
5555
Writing long characteristic values is not supported.
5656

57-
This is a limitation of the :ref:`zephyr:smp_svr_sample`, not of the SMP Client.
57+
This is a limitation of the :zephyr:code-sample:`smp-svr`, not of the SMP Client.
5858

5959
Sending a command
6060
=================

doc/nrf/releases_and_maturity/known_issues.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ Only secure applications can use Bluetooth® LE
213213
.. rst-class:: v1-2-1 v1-2-0 v1-1-0
214214

215215
:kconfig:option:`CONFIG_BT_SMP` alignment requirement
216-
When running the :ref:`bluetooth_central_dfu_smp` sample, the :kconfig:option:`CONFIG_BT_SMP` configuration must be aligned between this sample and the Zephyr counterpart (:ref:`zephyr:smp_svr_sample`).
216+
When running the :ref:`bluetooth_central_dfu_smp` sample, the :kconfig:option:`CONFIG_BT_SMP` configuration must be aligned between this sample and the Zephyr counterpart (:zephyr:code-sample:`smp-svr`).
217217
However, security is not enabled by default in the Zephyr sample.
218218

219219

@@ -1796,8 +1796,8 @@ NCSDK-21709: :ref:`peripheral_uart` sample does not work on nRF52810 and nRF5281
17961796

17971797
.. rst-class:: v2-3-0 v2-2-0
17981798

1799-
NCSDK-18112: :ref:`bluetooth_central_dfu_smp` sample cannot do discovery on the :ref:`smp_svr_sample`
1800-
The :ref:`bluetooth_central_dfu_smp` sample cannot perform the GATT discovery on a DK with the :ref:`smp_svr_sample`.
1799+
NCSDK-18112: :ref:`bluetooth_central_dfu_smp` sample cannot do discovery on the :zephyr:code-sample:`smp-svr`
1800+
The :ref:`bluetooth_central_dfu_smp` sample cannot perform the GATT discovery on a DK with the :zephyr:code-sample:`smp-svr`.
18011801

18021802
**Workaround:** Enable the legacy LLCP mechanism (:kconfig:option:`CONFIG_BT_LL_SW_LLCP_LEGACY`).
18031803

@@ -4109,22 +4109,22 @@ The time returned by clock_gettime() API becomes incorrect after one week of upt
41094109
.. rst-class:: v1-4-2 v1-4-1 v1-4-0
41104110

41114111
NCSDK-6330: USB Mass Storage Sample Application fails MSC Tests from USB3CV test tool
4112-
:ref:`zephyr:usb_mass` fails the USB3CV compliance Command Set Test from the MSC Tests suite.
4112+
:zephyr:code-sample:`usb-mass` fails the USB3CV compliance Command Set Test from the MSC Tests suite.
41134113

41144114
.. rst-class:: v1-4-2 v1-4-1 v1-4-0
41154115

41164116
NCSDK-6328: USB CDC ACM Composite Sample Application fails Chapter 9 Tests from USB3CV test tool
4117-
:ref:`zephyr:usb_cdc-acm_composite` fails the USB3CV compliance TD 9.1: Device Descriptor Test from the Chapter 9 Test suite.
4117+
:zephyr:code-sample:`usb-cdc-acm-composite` fails the USB3CV compliance TD 9.1: Device Descriptor Test from the Chapter 9 Test suite.
41184118

41194119
.. rst-class:: v1-4-2 v1-4-1 v1-4-0
41204120

41214121
NCSDK-6331: WebUSB sample application fails Chapter 9 Tests from USB3CV test tool
4122-
:ref:`zephyr:webusb-sample` fails the USB3CV compliance TD 9.21: LPM L1 Suspend Resume Test from the Chapter 9 Test suite.
4122+
:zephyr:code-sample:`webusb` fails the USB3CV compliance TD 9.21: LPM L1 Suspend Resume Test from the Chapter 9 Test suite.
41234123

41244124
.. rst-class:: v1-3-2 v1-3-1 v1-3-0
41254125

41264126
FOTA does not work
4127-
FOTA with the :ref:`zephyr:smp_svr_sample` does not work.
4127+
FOTA with the :zephyr:code-sample:`smp-svr` does not work.
41284128

41294129
**Affected platforms:** nRF5340
41304130

@@ -4137,18 +4137,18 @@ NCSIDB-108: Thread context switch might lead to a kernel fault
41374137
.. rst-class:: v1-0-0
41384138

41394139
Counter Alarm sample does not work
4140-
The :ref:`zephyr:alarm_sample` does not work.
4140+
The :zephyr:code-sample:`alarm` does not work.
41414141
A fix can be found in `Pull Request #16736 <https://github.com/zephyrproject-rtos/zephyr/pull/16736>`_.
41424142

41434143
.. rst-class:: v1-3-0 v1-2-1 v1-2-0 v1-1-0 v1-0-0
41444144

41454145
USB Mass Storage Sample Application compilation issues
4146-
:ref:`zephyr:usb_mass` does not compile.
4146+
:zephyr:code-sample:`usb-mass` does not compile.
41474147

41484148
.. rst-class:: v1-7-1 v1-7-0 v1-4-2 v1-4-1 v1-4-0
41494149

41504150
NCSDK-6832: SMP Server sample fails upon initialization
4151-
The :ref:`zephyr:smp_svr_sample` will fail upon initialization when using the :file:`bt-overlay.conf` Kconfig overlay file.
4151+
The :zephyr:code-sample:`smp-svr` will fail upon initialization when using the :file:`bt-overlay.conf` Kconfig overlay file.
41524152
This happens because of a stack overflow.
41534153

41544154
**Workaround:** Set :kconfig:option:`CONFIG_MAIN_STACK_SIZE` to ``2048``.

doc/nrf/releases_and_maturity/releases/release-notes-1.0.0.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -312,8 +312,8 @@ DFU
312312
Zephyr
313313
======
314314

315-
* The :ref:`zephyr:alarm_sample` does not work. A fix can be found in `Pull Request #16736 <https://github.com/zephyrproject-rtos/zephyr/pull/16736>`_.
316-
* :ref:`zephyr:usb_mass` does not compile.
315+
* The :zephyr:code-sample:`alarm` does not work. A fix can be found in `Pull Request #16736 <https://github.com/zephyrproject-rtos/zephyr/pull/16736>`_.
316+
* :zephyr:code-sample:`usb-mass` does not compile.
317317

318318
nrfxlib
319319
=======

doc/nrf/releases_and_maturity/releases/release-notes-1.1.0.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -522,7 +522,7 @@ Bluetooth Low Energy
522522
If a directed high duty cycle advertiser times out, the application might have to wait a short time before starting a new connectable advertiser.
523523
Otherwise, starting the advertiser will fail.
524524
* Bluetooth Low Energy peripheral samples are unstable in some conditions (when pairing and bonding are performed and then disconnections/re-connections happen).
525-
* When running the :ref:`bluetooth_central_dfu_smp` sample, the :kconfig:option:`CONFIG_BT_SMP` configuration must be aligned between this sample and the Zephyr counterpart (:ref:`zephyr:smp_svr_sample`).
525+
* When running the :ref:`bluetooth_central_dfu_smp` sample, the :kconfig:option:`CONFIG_BT_SMP` configuration must be aligned between this sample and the Zephyr counterpart (:zephyr:code-sample:`smp-svr`).
526526
However, security is not enabled by default in the Zephyr sample.
527527
* The central samples (:ref:`central_uart`, :ref:`bluetooth_central_hids`) do not support any pairing methods with MITM protection.
528528
* On some operating systems, the nrf_desktop application is unable to reconnect to a host.

doc/nrf/releases_and_maturity/releases/release-notes-1.2.0.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -555,7 +555,7 @@ Bluetooth Low Energy
555555
NFC requires this API to work correctly.
556556
* When the :ref:`peripheral_hids_mouse` sample is used with the Zephyr Bluetooth LE Controller, directed advertising does not time out and the regular advertising cannot be started.
557557
* The :ref:`bluetooth_central_hids` sample cannot connect to a peripheral that uses directed advertising.
558-
* When running the :ref:`bluetooth_central_dfu_smp` sample, the :kconfig:option:`CONFIG_BT_SMP` configuration must be aligned between this sample and the Zephyr counterpart (:ref:`zephyr:smp_svr_sample`).
558+
* When running the :ref:`bluetooth_central_dfu_smp` sample, the :kconfig:option:`CONFIG_BT_SMP` configuration must be aligned between this sample and the Zephyr counterpart (:zephyr:code-sample:`smp-svr`).
559559
However, security is not enabled by default in the Zephyr sample.
560560
* The central samples (:ref:`central_uart`, :ref:`bluetooth_central_hids`) do not support any pairing methods with MITM protection.
561561
* On some operating systems, the nrf_desktop application is unable to reconnect to a host.

0 commit comments

Comments
 (0)