You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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]>
Copy file name to clipboardExpand all lines: doc/nrf/device_guides/working_with_nrf/nrf52/developing.rst
+3-3
Original file line number
Diff line number
Diff line change
@@ -78,7 +78,7 @@ Here is an example of how you can build for the :ref:`peripheral_lbs` sample:
78
78
west build -b *build_target* -- -DCONFIG_BOOTLOADER_MCUBOOT=y -DCONFIG_NCS_SAMPLE_MCUMGR_BT_OTA_DFU=y
79
79
80
80
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`.
Copy file name to clipboardExpand all lines: doc/nrf/device_guides/working_with_nrf/nrf53/nrf5340.rst
+4-4
Original file line number
Diff line number
Diff line change
@@ -161,7 +161,7 @@ Bluetooth Low Energy
161
161
162
162
* - Network core
163
163
- Application core
164
-
* - :ref:`zephyr:bluetooth-hci-rpmsg-sample`
164
+
* - :ref:`zephyr:bluetooth-hci-ipc-sample`
165
165
- | :ref:`Bluetooth Low Energy samples <ble_samples>`
166
166
|:ref:`Bluetooth samples in Zephyr <zephyr:bluetooth-samples>`
167
167
* - :ref:`ble_rpc_host` (supported for development)
@@ -177,7 +177,7 @@ Split Controller and Host
177
177
178
178
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.
179
179
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.
181
181
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.
182
182
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).
183
183
@@ -257,7 +257,7 @@ When using Thread or Zigbee in parallel with Bluetooth LE, run the low-level rad
257
257
Bluetooth LE and IEEE 802.15.4 multiprotocol architecture in multicore SoC
258
258
259
259
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).
261
261
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`_.
262
262
Separate RPMsg endpoints are used to obtain independent inter-core connections for each stack.
263
263
@@ -354,7 +354,7 @@ The combination of these options determines which (if any) sample is included in
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`).
217
217
However, security is not enabled by default in the Zephyr sample.
218
218
219
219
@@ -1796,8 +1796,8 @@ NCSDK-21709: :ref:`peripheral_uart` sample does not work on nRF52810 and nRF5281
1796
1796
1797
1797
.. rst-class:: v2-3-0 v2-2-0
1798
1798
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`.
1801
1801
1802
1802
**Workaround:** Enable the legacy LLCP mechanism (:kconfig:option:`CONFIG_BT_LL_SW_LLCP_LEGACY`).
1803
1803
@@ -4109,22 +4109,22 @@ The time returned by clock_gettime() API becomes incorrect after one week of upt
4109
4109
.. rst-class:: v1-4-2 v1-4-1 v1-4-0
4110
4110
4111
4111
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.
4113
4113
4114
4114
.. rst-class:: v1-4-2 v1-4-1 v1-4-0
4115
4115
4116
4116
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.
4118
4118
4119
4119
.. rst-class:: v1-4-2 v1-4-1 v1-4-0
4120
4120
4121
4121
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.
4123
4123
4124
4124
.. rst-class:: v1-3-2 v1-3-1 v1-3-0
4125
4125
4126
4126
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.
4128
4128
4129
4129
**Affected platforms:** nRF5340
4130
4130
@@ -4137,18 +4137,18 @@ NCSIDB-108: Thread context switch might lead to a kernel fault
4137
4137
.. rst-class:: v1-0-0
4138
4138
4139
4139
Counter Alarm sample does not work
4140
-
The :ref:`zephyr:alarm_sample` does not work.
4140
+
The :zephyr:code-sample:`alarm` does not work.
4141
4141
A fix can be found in `Pull Request #16736 <https://github.com/zephyrproject-rtos/zephyr/pull/16736>`_.
4142
4142
4143
4143
.. rst-class:: v1-3-0 v1-2-1 v1-2-0 v1-1-0 v1-0-0
4144
4144
4145
4145
USB Mass Storage Sample Application compilation issues
4146
-
:ref:`zephyr:usb_mass` does not compile.
4146
+
:zephyr:code-sample:`usb-mass` does not compile.
4147
4147
4148
4148
.. rst-class:: v1-7-1 v1-7-0 v1-4-2 v1-4-1 v1-4-0
4149
4149
4150
4150
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.
4152
4152
This happens because of a stack overflow.
4153
4153
4154
4154
**Workaround:** Set :kconfig:option:`CONFIG_MAIN_STACK_SIZE` to ``2048``.
Copy file name to clipboardExpand all lines: doc/nrf/releases_and_maturity/releases/release-notes-1.0.0.rst
+2-2
Original file line number
Diff line number
Diff line change
@@ -312,8 +312,8 @@ DFU
312
312
Zephyr
313
313
======
314
314
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.
Copy file name to clipboardExpand all lines: doc/nrf/releases_and_maturity/releases/release-notes-1.1.0.rst
+1-1
Original file line number
Diff line number
Diff line change
@@ -522,7 +522,7 @@ Bluetooth Low Energy
522
522
If a directed high duty cycle advertiser times out, the application might have to wait a short time before starting a new connectable advertiser.
523
523
Otherwise, starting the advertiser will fail.
524
524
* 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`).
526
526
However, security is not enabled by default in the Zephyr sample.
527
527
* The central samples (:ref:`central_uart`, :ref:`bluetooth_central_hids`) do not support any pairing methods with MITM protection.
528
528
* On some operating systems, the nrf_desktop application is unable to reconnect to a host.
Copy file name to clipboardExpand all lines: doc/nrf/releases_and_maturity/releases/release-notes-1.2.0.rst
+1-1
Original file line number
Diff line number
Diff line change
@@ -555,7 +555,7 @@ Bluetooth Low Energy
555
555
NFC requires this API to work correctly.
556
556
* 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.
557
557
* 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`).
559
559
However, security is not enabled by default in the Zephyr sample.
560
560
* The central samples (:ref:`central_uart`, :ref:`bluetooth_central_hids`) do not support any pairing methods with MITM protection.
561
561
* On some operating systems, the nrf_desktop application is unable to reconnect to a host.
Copy file name to clipboardExpand all lines: doc/nrf/releases_and_maturity/releases/release-notes-1.3.0.rst
+3-3
Original file line number
Diff line number
Diff line change
@@ -168,7 +168,7 @@ nRF5340 SoC
168
168
-----------
169
169
170
170
* Added :ref:`nrf5340_empty_app_core` for samples running purely on the nRF5340 network core.
171
-
* When building a Bluetooth sample for nRF5340, the :ref:`zephyr:bluetooth-hci-rpmsg-sample` sample is now automatically built as child image.
171
+
* When building a Bluetooth sample for nRF5340, the :ref:`zephyr:bluetooth-hci-ipc-sample` sample is now automatically built as child image.
172
172
173
173
Multiprotocol Service Layer (MPSL)
174
174
-----------------------------------
@@ -476,7 +476,7 @@ nRF5
476
476
nRF5340
477
477
-------
478
478
479
-
* FOTA with the :ref:`zephyr:smp_svr_sample` does not work.
479
+
* FOTA with the :zephyr:code-sample:`smp-svr` does not work.
480
480
481
481
nRF52820
482
482
--------
@@ -588,7 +588,7 @@ Bluetooth Low Energy
588
588
NFC requires this API to work correctly. (fixed)
589
589
* 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. (fixed)
590
590
* The :ref:`bluetooth_central_hids` sample cannot connect to a peripheral that uses directed advertising. (fixed)
591
-
* 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`).
591
+
* 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`).
592
592
However, security is not enabled by default in the Zephyr sample. (fixed)
593
593
* On some operating systems, the nrf_desktop application is unable to reconnect to a host. (fixed)
Copy file name to clipboardExpand all lines: doc/nrf/releases_and_maturity/releases/release-notes-1.5.0.rst
+7-7
Original file line number
Diff line number
Diff line change
@@ -153,7 +153,7 @@ nRF5340 SoC
153
153
154
154
* :ref:`esb_readme` subsystem - Added support for nRF5340 (CPUNET) in the ESB subsystem.
155
155
* Secure Partition Manager (SPM) subsystem - Added support for nRF5340 peripherals in non-secure applications.
156
-
* :ref:`ble_samples` - Added configuration overlays for child image to the required Bluetooth LE samples so that no Kconfig updates in the :ref:`zephyr:bluetooth-hci-rpmsg-sample` sample are needed by default.
156
+
* :ref:`ble_samples` - Added configuration overlays for child image to the required Bluetooth LE samples so that no Kconfig updates in the :ref:`zephyr:bluetooth-hci-ipc-sample` sample are needed by default.
157
157
* :ref:`nrf5340_empty_app_core` sample - Disabled the kernel memory pool option :kconfig:option:`CONFIG_KERNEL_MEM_POOL` to reduce the memory footprint.
158
158
* ``bl_boot`` library - Disabled clock interrupts before booting the application. This change fixes an issue where the :ref:`bootloader` sample would not be able to boot a Zephyr application on the nRF5340 SoC.
159
159
@@ -734,7 +734,7 @@ The following list summarizes the most important changes inherited from upstream
734
734
* Added multiple minor TCP2 bugfixes and improvements.
735
735
* Added support for RX packet queueing in TCP2.
736
736
* Added network management events for DHCPv4.
737
-
* Added periodic throughput printout to the :ref:`zephyr:sockets-echo-server-sample` sample.
737
+
* Added periodic throughput printout to the :zephyr:code-sample:`sockets-echo-server` sample.
738
738
* Added an experimental option to set preemptive priority for networking threads (:kconfig:option:`CONFIG_NET_TC_THREAD_PREEMPTIVE`).
739
739
* Added a Kconfig option that enables a hostname update on link address change (:kconfig:option:`CONFIG_NET_HOSTNAME_UNIQUE_UPDATE`).
740
740
* Added multiple fixes to the DHCP implementation.
@@ -867,12 +867,12 @@ The following list summarizes the most important changes inherited from upstream
Copy file name to clipboardExpand all lines: doc/nrf/releases_and_maturity/releases/release-notes-2.0.0.rst
+1-1
Original file line number
Diff line number
Diff line change
@@ -540,7 +540,7 @@ Other samples
540
540
* Improved the calculation of the total payload size for the radio duty cycle.
541
541
* Fast ramp-up is enabled for all radio modes.
542
542
* The duty cycle for modulated transmission is limited to 1-90%.
543
-
* Improved the DFU throughput in the :ref:`smp_svr_sample` for the Bluetooth transport by optimizing Bluetooth MTU configuration and by leveraging the MCUmgr packet reassembly feature.
543
+
* Improved the DFU throughput in the :zephyr:code-sample:`smp-svr` for the Bluetooth transport by optimizing Bluetooth MTU configuration and by leveraging the MCUmgr packet reassembly feature.
0 commit comments