Skip to content

Commit 706091a

Browse files
greg-ferrlubos
authored andcommitted
doc: crypto: fix undefined Kconfig references
Fixed undefined Kconfig option references in crypto docs in sdk-nrf. NCSDK-34361. Signed-off-by: Grzegorz Ferenc <[email protected]>
1 parent 3bb415b commit 706091a

File tree

4 files changed

+6
-9
lines changed

4 files changed

+6
-9
lines changed

doc/nrf/links.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -647,8 +647,8 @@
647647
.. _`CONFIG_SSF_PSA_CRYPTO_SERVICE_ENABLED`: https://docs.nordicsemi.com/bundle/ncs-latest/page/kconfig/index.html#!CONFIG_SSF_PSA_CRYPTO_SERVICE_ENABLED
648648
.. _`Matter factory data Kconfig options`: https://docs.nordicsemi.com/bundle/ncs-latest/page/kconfig/index.html#!CHIP_FACTORY_DATA
649649
.. _`Kconfig search results`: https://docs.nordicsemi.com/bundle/ncs-latest/page/kconfig/index.html#!CONFIG_PM_PARTITION_SIZE
650-
.. _`CONFIG_PSA_WANT_*`: https://docs.nordicsemi.com/bundle/ncs-latest/page/kconfig/index.html#!CONFIG_PSA_WANT_
651-
.. _`CONFIG_PSA_USE_*`: https://docs.nordicsemi.com/bundle/ncs-latest/page/kconfig/index.html#!CONFIG_PSA_USE_
650+
.. _`CONFIG_PSA_WANT_*`: https://docs.nordicsemi.com/bundle/ncs-latest/page/kconfig/index.html#!CONFIG_PSA_WANT_*
651+
.. _`CONFIG_PSA_USE_*`: https://docs.nordicsemi.com/bundle/ncs-latest/page/kconfig/index.html#!CONFIG_PSA_USE_*
652652

653653
.. _`Threads`: https://docs.nordicsemi.com/bundle/ncs-latest/page/zephyr/kernel/services/threads/index.html
654654

doc/nrf/security/crypto/crypto_supported_features.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Cryptographic feature support
3434
The following sections list the supported cryptographic features and algorithms for each of the drivers: :ref:`nrf_cc3xx <crypto_drivers_cc3xx>`, :ref:`CRACEN <crypto_drivers_cracen>`, and :ref:`nrf_oberon <crypto_drivers_oberon>`.
3535
The listed Kconfig options enable the features and algorithms for the drivers that support them.
3636

37-
The Kconfig options follow the ``CONFIG_PSA_WANT_`` + ``CONFIG_PSA_USE_`` configuration scheme, which is described in detail on the :ref:`crypto_drivers` page.
37+
The Kconfig options follow the ``CONFIG_PSA_WANT_*`` + ``CONFIG_PSA_USE_*`` configuration scheme, which is described in detail on the :ref:`crypto_drivers` page.
3838

3939
Key types and key management
4040
============================
@@ -1059,7 +1059,7 @@ Key pair operations
10591059
===================
10601060

10611061
The following sections list the supported key pair operation Kconfig options for different key types.
1062-
The Kconfig options follow the ``CONFIG_PSA_WANT_`` configuration scheme, which is described in detail on the :ref:`crypto_drivers` page.
1062+
The Kconfig options follow the ``CONFIG_PSA_WANT_*`` configuration scheme, which is described in detail on the :ref:`crypto_drivers` page.
10631063

10641064
RSA key pair operations
10651065
-----------------------
@@ -1207,7 +1207,7 @@ Key size configurations
12071207
=======================
12081208

12091209
The following sections list the supported AES and RSA key size Kconfig options.
1210-
The Kconfig options follow the ``CONFIG_PSA_WANT_`` configuration scheme, which is described in detail on the :ref:`crypto_drivers` page.
1210+
The Kconfig options follow the ``CONFIG_PSA_WANT_*`` configuration scheme, which is described in detail on the :ref:`crypto_drivers` page.
12111211

12121212
AES key size configuration
12131213
--------------------------

doc/nrf/security/crypto/driver_config.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -114,9 +114,7 @@ When multiple enabled drivers support the same cryptographic feature, the config
114114
Configuring cryptographic features
115115
**********************************
116116

117-
You can enable a cryptographic feature or algorithm using `CONFIG_PSA_WANT_*`_ Kconfig options, which are specific for PSA Crypto API configurations.
118-
For example, to enable the AES algorithm, set the :kconfig:option:`CONFIG_PSA_WANT_ALG_AES` Kconfig option.
119-
117+
You can enable a cryptographic feature or algorithm using `CONFIG_PSA_WANT_*`_ and `CONFIG_PSA_USE_*`_ Kconfig options, which are specific to the :ref:`feature selection mechanism <crypto_drivers_feature_selection>` of the PSA Crypto API.
120118
For a list of supported cryptographic features and algorithms and the Kconfig options to enable them, see :ref:`ug_crypto_supported_features`.
121119

122120
Building PSA Crypto API

doc/nrfxlib/nrfxlib.doxyfile.in

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2403,7 +2403,6 @@ INCLUDE_FILE_PATTERNS =
24032403

24042404
PREDEFINED = __DOXYGEN__ \
24052405
"MBEDTLS_CONFIG_FILE=\"@OUTPUT_DIRECTORY@/mbedtls_doxygen_config.h\"" \
2406-
"CONFIG_MBEDTLS_VANILLA_BACKEND=y" \
24072406
"CONFIG_CC3XX_BACKEND=y" \
24082407
"CONFIG_SYS_CLOCK_EXISTS=y" \
24092408
"CONFIG_THREAD_MONITOR=y" \

0 commit comments

Comments
 (0)