Skip to content

Commit c1dcff6

Browse files
committed
treewide: explicitly tag all nrf docset references
So that we can easily filter them out during inventory build. Signed-off-by: Gerard Marull-Paretas <[email protected]>
1 parent de7bbb0 commit c1dcff6

File tree

12 files changed

+24
-24
lines changed

12 files changed

+24
-24
lines changed

crypto/doc/nrf_cc3xx_mbedcrypto.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The nrf_cc3xx_mbedcrypto library provides low-level integration with the Mbed TL
1717
Some of the APIs expressed in this library use the Mbed TLS "alternative implementation" abstraction layer.
1818

1919
.. note::
20-
It is not recommended to link to this library directly. Use the :ref:`nrf_security`.
20+
It is not recommended to link to this library directly. Use the :ref:`nrf:nrf_security`.
2121

2222

2323
Supported cryptographic algorithms
@@ -134,7 +134,7 @@ Otherwise, the library will default to use the clib functions :c:func:`calloc` a
134134
PSA driver integration
135135
======================
136136
Starting from version 0.9.13, the nrf_oberon library contains a companion library that provides PSA driver integration for select features.
137-
This must be used with the :ref:`nrf_security`.
137+
This must be used with the :ref:`nrf:nrf_security`.
138138

139139
Supported features
140140
------------------

crypto/doc/nrf_oberon.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ The library does not require any initialization before the APIs can be used, alt
3535
Mbed TLS integration
3636
====================
3737
Starting from version 3.0.5, the nrf_oberon library contains a companion library that provides Mbed TLS integration for select features.
38-
This must be used with the :ref:`nrf_security`.
38+
This must be used with the :ref:`nrf:nrf_security`.
3939

4040

4141
Supported features
@@ -55,7 +55,7 @@ The supported features for the Mbed TLS companion library are:
5555
PSA driver integration
5656
======================
5757
Starting from version 3.0.9, the nrf_oberon library contains a companion library that provides PSA driver integration for select features.
58-
This must be used with the :ref:`nrf_security`.
58+
This must be used with the :ref:`nrf:nrf_security`.
5959

6060
Supported features
6161
------------------

lc3/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Low Complexity Communication Codec (LC3)
88
:depth: 2
99

1010
Low Complexity Communication Codec (LC3) is the default software codec for the nRF5340 Audio application, conformant to the `Bluetooth® LE Audio specifications`_ (Bluetooth 5.2).
11-
For more information about the codec usage in the application, see the :ref:`application documentation page <nrf53_audio_app>`.
11+
For more information about the codec usage in the application, see the :ref:`application documentation page <nrf:nrf53_audio_app>`.
1212

1313
The nrfxlib module includes the :file:`lc3/include/sw_codec_lc3.h` and :file:`lc3/src/sw_codec_lc3.c` files that form a translation layer for using a standardized API in the nRF5340 Audio application.
1414

mpsl/doc/cx.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,13 @@ Selecting CX Implementation
3535
***************************
3636

3737
The :ref:`mpsl` itself does not provide any implementation of the CX interface.
38-
For details on the implementations present in the |NCS|, see :ref:`ug_radio_coex`.
38+
For details on the implementations present in the |NCS|, see :ref:`nrf:ug_radio_coex`.
3939
An application that needs to use CX must call :c:func:`mpsl_cx_interface_set()` during the system initialization.
4040
The initialization of any resource needed by the selected CX implementation is not in scope of :ref:`mpsl` and must also be done during the system initialization.
4141

4242
.. note::
4343
In the |NCS|, the selection of a CX implementation and its appropriate initialization is done automatically, using Kconfig and Device Tree configuration options.
44-
Please refer to :ref:`ug_radio_coex`.
44+
Please refer to :ref:`nrf:ug_radio_coex`.
4545

4646
Using CX API in a protocol driver
4747
*********************************
@@ -51,5 +51,5 @@ To use the CX API in a protocol driver, you must follow the :ref:`MPSL CX API <m
5151
Implementing CX API
5252
*******************
5353

54-
For details on the implementations of the MPSL CX API for certain PTAs already supported by the |NCS|, see :ref:`ug_radio_coex`.
55-
If your PTA is not supported yet, see :ref:`ug_radio_mpsl_cx_custom` for guidelines on how to add your own implementation.
54+
For details on the implementations of the MPSL CX API for certain PTAs already supported by the |NCS|, see :ref:`nrf:ug_radio_coex`.
55+
If your PTA is not supported yet, see :ref:`nrf:ug_radio_mpsl_cx_custom` for guidelines on how to add your own implementation.

nrf_802154/doc/rd_limitations.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Limitations
44
###########
55

66
When working with the nRF 802.15.4 Radio Driver, you should be aware of the following limitations.
7-
In addition, see :ref:`known_issues` for temporary issues that will be fixed in future releases.
7+
In addition, see :ref:`nrf:known_issues` for temporary issues that will be fixed in future releases.
88

99
IRQ priority limitations
1010
Application and device drivers (excluding those compliant with :ref:`mpsl`) must not use IRQ priority higher than :c:macro:`NRF_802154_SWI_PRIORITY` and :c:macro:`NRF_802154_SL_RTC_IRQ_PRIORITY`.
@@ -13,4 +13,4 @@ KRKNWK-11204: Transmitting an 802.15.4 frame with improperly populated Auxiliary
1313
**Workaround:** Make sure that you populate the Auxiliary Security Header field according to the IEEE Std 802.15.4-2015 specification, section 9.4.
1414

1515
KRKNWK-12482: Reception of correct frames will occasionally end in failure with error ``NRF_802154_RX_ERROR_RUNTIME``
16-
This issue can occur for the ``nrf5340dk_nrf5340_cpunet`` target if a custom application (other than :ref:`multiprotocol-rpmsg-sample` sample or :ref:`zephyr:nrf-ieee802154-rpmsg-sample` sample) is used.
16+
This issue can occur for the ``nrf5340dk_nrf5340_cpunet`` target if a custom application (other than :ref:`nrf:multiprotocol-rpmsg-sample` sample or :ref:`zephyr:nrf-ieee802154-rpmsg-sample` sample) is used.

nrf_modem/doc/at_interface.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -346,13 +346,13 @@ The following snippet shows how to setup an AT notification handler:
346346
The callback is invoked in an interrupt context.
347347
The user is responsible for rescheduling the processing of AT notifications as appropriate.
348348

349-
In |NCS|, the :ref:`at_monitor_readme` library takes care of dispatching notifications to different parts of the application.
349+
In |NCS|, the :ref:`nrf:at_monitor_readme` library takes care of dispatching notifications to different parts of the application.
350350

351351
.. important::
352-
In |NCS| applications, many libraries use the :ref:`at_monitor_readme` library to register their own callback with the Modem library using the :c:func:`nrf_modem_at_notif_handler_set` function.
352+
In |NCS| applications, many libraries use the :ref:`nrf:at_monitor_readme` library to register their own callback with the Modem library using the :c:func:`nrf_modem_at_notif_handler_set` function.
353353
If you are building an |NCS| application, do not use the :c:func:`nrf_modem_at_notif_handler_set` function to register your callback.
354-
Instead, use the :ref:`at_monitor_readme` library to dispatch AT notifications to where you need them in your application, and to ensure compatibility with other |NCS| libraries.
355-
The :ref:`at_monitor_readme` library also takes care of rescheduling the notifications to a thread context.
354+
Instead, use the :ref:`nrf:at_monitor_readme` library to dispatch AT notifications to where you need them in your application, and to ensure compatibility with other |NCS| libraries.
355+
The :ref:`nrf:at_monitor_readme` library also takes care of rescheduling the notifications to a thread context.
356356

357357
Thread safety
358358
*************

nrf_modem/doc/fault_handling.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ When the modem crashes, the modem fault handler set by the application is called
2020
In some cases, the modem fault handler also contains information about the program counter of the modem.
2121
For a complete list of the modem fault reasons, see :ref:`nrf_modem_fault_api_reasons`.
2222

23-
In |NCS|, the :ref:`nrf_modem_lib_readme` sets the modem fault handler during Modem library initialization.
23+
In |NCS|, the :ref:`nrf:nrf_modem_lib_readme` sets the modem fault handler during Modem library initialization.
2424

2525
Recovering from a fault
2626
***********************
@@ -38,7 +38,7 @@ The application can reinitialize the modem by reinitializing the Modem library t
3838
To make sure the application is able to retrieve the coredump correctly, the application must not re-initialize the modem until all the outstanding trace data has been processed.
3939
The :c:func:`nrf_modem_trace_get` function returns ``-NRF_ENODATA`` when all outstanding trace data has been processed by the application.
4040

41-
When the Modem library is used in |NCS|, the :ref:`nrf_modem_lib_readme` handles synchronizing modem re-initialization with tracing operations.
41+
When the Modem library is used in |NCS|, the :ref:`nrf:nrf_modem_lib_readme` handles synchronizing modem re-initialization with tracing operations.
4242

4343
Networking sockets
4444
******************

nrf_modem/doc/gnss_interface.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ If the fix retry parameter is set to zero, GNSS is allowed to run indefinitely u
161161
162162
.. note::
163163

164-
Unless disabled using the :c:func:`nrf_modem_gnss_use_case_set` function, GNSS performs :term:`Scheduled downloads` in periodic navigation mode.
164+
Unless disabled using the :c:func:`nrf_modem_gnss_use_case_set` function, GNSS performs :term:`nrf:Scheduled downloads` in periodic navigation mode.
165165
During a scheduled download, the fix interval and fix retry parameters are temporarily ignored.
166166
After GNSS has downloaded the data it needs, normal operation is resumed.
167167

@@ -483,7 +483,7 @@ A-GNSS data
483483
***********
484484

485485
You can use GNSS assistance data to shorten TTFF and decrease GNSS power consumption.
486-
See :ref:`lib_nrf_cloud_agps` and :ref:`lib_nrf_cloud_pgps` for information how to obtain assistance data from :ref:`lib_nrf_cloud` to be used with the nRF91 Series SiPs.
486+
See :ref:`nrf:lib_nrf_cloud_agps` and :ref:`nrf:lib_nrf_cloud_pgps` for information how to obtain assistance data from :ref:`nrf:lib_nrf_cloud` to be used with the nRF91 Series SiPs.
487487

488488
.. _gnss_int_assistance_need:
489489

nrf_modem/doc/modem_trace.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Modem traces
1111
The modem trace APIs in the Modem library are used to retrieve binary trace data from the modem core.
1212
The application is responsible for forwarding the trace data to a host computer, where it can be collected with the `Cellular Monitor`_ PC tool to extract PCAP data, or to save them to file for further inspection by Nordic Semiconductor.
1313

14-
In the |NCS|, the :ref:`nrf_modem_lib_readme` takes care of retrieving and forwarding the trace data, for example to a computer or to a non-volatile memory.
14+
In the |NCS|, the :ref:`nrf:nrf_modem_lib_readme` takes care of retrieving and forwarding the trace data, for example to a computer or to a non-volatile memory.
1515

1616
Enabling modem traces
1717
*********************
@@ -20,7 +20,7 @@ To enable traces the application must initialize the Modem library with a non-ze
2020
The trace output from the modem can be toggled at runtime using the AT command ``%XMODEMTRACE``, which can also be used to change the trace output level.
2121
For more information, see the `Modem trace activation %XMODEMTRACE`_ section in the nRF9160 AT Commands Reference Guide or the `same section <nRF91x1 modem trace activation %XMODEMTRACE_>`_ in the nRF91x1 AT Commands Reference Guide, depending on the SiP you are using.
2222

23-
In the |NCS|, the :ref:`nrf_modem_lib_readme` offers a dedicated function to simplify the task of enabling and disabling the trace output, and setting the trace level.
23+
In the |NCS|, the :ref:`nrf:nrf_modem_lib_readme` offers a dedicated function to simplify the task of enabling and disabling the trace output, and setting the trace level.
2424

2525
Fetching modem traces
2626
*********************

nrf_modem/doc/sockets/pdn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ To configure PDP contexts and activate PDN connections, the application must use
1414
When performing network operations on any PDN, the application ensures that the PDN connection is available.
1515
For more information about how to configure PDP contexts, activate PDN connections, and determine their state, see the `Packet domain commands`_ section in the nRF9160 AT Commands Reference Guide or the same section in the `nRF91x1 AT Commands Reference Guide`_ depending on the SiP you are using.
1616

17-
Alternatively, the :ref:`pdn_readme` library in |NCS| can be used to receive events on PDN connectivity and manage packet data networks.
17+
Alternatively, the :ref:`nrf:pdn_readme` library in |NCS| can be used to receive events on PDN connectivity and manage packet data networks.
1818

1919

2020
Configuring a socket to use a PDN

0 commit comments

Comments
 (0)