Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: extensions: add kconfig search extension #41753

Merged
merged 4 commits into from Mar 2, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 6 additions & 6 deletions boards/arc/em_starterkit/doc/index.rst
Expand Up @@ -68,16 +68,16 @@ In Zephyr, only firmware versions 2.2 and 2.3 are supported.

* For EM Starter Kit 2.2, EM7D, EM9D and EM11D core configurations are supported.

* Use :kconfig:`CONFIG_BOARD_EM_STARTERKIT_R22` to select 2.2 version.
* Use :kconfig:`CONFIG_SOC_EMSK_EM7D`, :kconfig:`CONFIG_SOC_EMSK_EM9D` or
:kconfig:`CONFIG_SOC_EMSK_EM11D` to select EM7D or EM9D or EM11D.
* Use :kconfig:option:`CONFIG_BOARD_EM_STARTERKIT_R22` to select 2.2 version.
* Use :kconfig:option:`CONFIG_SOC_EMSK_EM7D`, :kconfig:option:`CONFIG_SOC_EMSK_EM9D` or
:kconfig:option:`CONFIG_SOC_EMSK_EM11D` to select EM7D or EM9D or EM11D.

* For EM Starter Kit 2.3, EM7D, EM9D and EM11D core configurations are
supported.

* Use :kconfig:`CONFIG_BOARD_EM_STARTERKIT_R23` to select 2.3 version.
* Use :kconfig:`CONFIG_SOC_EMSK_EM7D`, :kconfig:`CONFIG_SOC_EMSK_EM9D` or
:kconfig:`CONFIG_SOC_EMSK_EM11D` to select EM7D or EM9D or EM11D.
* Use :kconfig:option:`CONFIG_BOARD_EM_STARTERKIT_R23` to select 2.3 version.
* Use :kconfig:option:`CONFIG_SOC_EMSK_EM7D`, :kconfig:option:`CONFIG_SOC_EMSK_EM9D` or
:kconfig:option:`CONFIG_SOC_EMSK_EM11D` to select EM7D or EM9D or EM11D.

Supported Features
==================
Expand Down
8 changes: 4 additions & 4 deletions boards/arc/emsdp/doc/index.rst
Expand Up @@ -26,10 +26,10 @@ Hardware

The EM Software Development Platform supports different core configurations, such as EM4,
EM5D, EM6, EM7D, EM9D, EM9D+ESP, EM11D, the default core configuration is EM11D. Use
:kconfig:`CONFIG_SOC_EMSDP_EM4`, :kconfig:`CONFIG_SOC_EMSDP_EM5D`,
:kconfig:`CONFIG_SOC_EMSDP_EM6`, :kconfig:`CONFIG_SOC_EMSDP_EM7D`,
:kconfig:`CONFIG_SOC_EMSDP_EM7D_ESP`, :kconfig:`CONFIG_SOC_EMSDP_EM9D` or
:kconfig:`CONFIG_SOC_EMSDP_EM11D` to select different core configuration.
:kconfig:option:`CONFIG_SOC_EMSDP_EM4`, :kconfig:option:`CONFIG_SOC_EMSDP_EM5D`,
:kconfig:option:`CONFIG_SOC_EMSDP_EM6`, :kconfig:option:`CONFIG_SOC_EMSDP_EM7D`,
:kconfig:option:`CONFIG_SOC_EMSDP_EM7D_ESP`, :kconfig:option:`CONFIG_SOC_EMSDP_EM9D` or
:kconfig:option:`CONFIG_SOC_EMSDP_EM11D` to select different core configuration.

The following table shows the hardware features supported for different core configuration:

Expand Down
2 changes: 1 addition & 1 deletion boards/arm/arty/doc/index.rst
Expand Up @@ -184,7 +184,7 @@ the next time the FPGA is configured.

The steps to persist the application within the FPGA bitstream are covered by
the ARM Cortex-M1/M3 DesignStart FPGA Xilinx edition user guide. If the
:kconfig:`CONFIG_BUILD_OUTPUT_BIN` is enabled and the `SiFive elf2hex`_ package
:kconfig:option:`CONFIG_BUILD_OUTPUT_BIN` is enabled and the `SiFive elf2hex`_ package
is available, the build system will automatically generate a Verilog memory hex
dump :file:`zephyr.mem` file suitable for initialising the block RAM using
`Xilinx Vivado`_.
Expand Down
4 changes: 2 additions & 2 deletions boards/arm/cc1352r1_launchxl/doc/index.rst
Expand Up @@ -196,7 +196,7 @@ Bootloader
The ROM bootloader on CC13x2 and CC26x2 devices is enabled by default. The
bootloader will start if there is no valid application image in flash or the
so-called backdoor is enabled (via option
:kconfig:`CONFIG_CC13X2_CC26X2_BOOTLOADER_BACKDOOR_ENABLE`) and BTN-1 is held
:kconfig:option:`CONFIG_CC13X2_CC26X2_BOOTLOADER_BACKDOOR_ENABLE`) and BTN-1 is held
down during reset. See the bootloader documentation in chapter 10 of the `TI
CC13x2 / CC26x2 Technical Reference Manual`_ for additional information.

Expand All @@ -205,7 +205,7 @@ Power Management and UART

System and device power management are supported on this platform, and
can be enabled via the standard Kconfig options in Zephyr, such as
:kconfig:`CONFIG_PM`, :kconfig:`CONFIG_PM_DEVICE`.
:kconfig:option:`CONFIG_PM`, :kconfig:option:`CONFIG_PM_DEVICE`.

When system power management is turned on (CONFIG_PM=y),
sleep state 2 (standby mode) is allowed, and polling is used to retrieve input
Expand Down
4 changes: 2 additions & 2 deletions boards/arm/cc1352r_sensortag/doc/index.rst
Expand Up @@ -222,7 +222,7 @@ Bootloader
The ROM bootloader on CC13x2 and CC26x2 devices is enabled by default. The
bootloader will start if there is no valid application image in flash or the
so-called backdoor is enabled (via option
:kconfig:`CONFIG_CC13X2_CC26X2_BOOTLOADER_BACKDOOR_ENABLE`) and BTN-1 is held
:kconfig:option:`CONFIG_CC13X2_CC26X2_BOOTLOADER_BACKDOOR_ENABLE`) and BTN-1 is held
down during reset. See the bootloader documentation in chapter 10 of the `TI
CC13x2 / CC26x2 Technical Reference Manual`_ for additional information.

Expand All @@ -231,7 +231,7 @@ Power Management and UART

System and device power management are supported on this platform, and
can be enabled via the standard Kconfig options in Zephyr, such as
:kconfig:`CONFIG_PM`, :kconfig:`CONFIG_PM_DEVICE`.
:kconfig:option:`CONFIG_PM`, :kconfig:option:`CONFIG_PM_DEVICE`.

When system power management is turned on (CONFIG_PM=y),
sleep state 2 (standby mode) is allowed, and polling is used to retrieve input
Expand Down
4 changes: 2 additions & 2 deletions boards/arm/cc26x2r1_launchxl/doc/index.rst
Expand Up @@ -202,7 +202,7 @@ Bootloader
The ROM bootloader on CC13x2 and CC26x2 devices is enabled by default. The
bootloader will start if there is no valid application image in flash or the
so-called backdoor is enabled (via option
:kconfig:`CONFIG_CC13X2_CC26X2_BOOTLOADER_BACKDOOR_ENABLE`) and BTN-1 is held
:kconfig:option:`CONFIG_CC13X2_CC26X2_BOOTLOADER_BACKDOOR_ENABLE`) and BTN-1 is held
down during reset. See the bootloader documentation in chapter 10 of the `TI
CC13x2 / CC26x2 Technical Reference Manual`_ for additional information.

Expand All @@ -211,7 +211,7 @@ Power Management and UART

System and device power management are supported on this platform, and
can be enabled via the standard Kconfig options in Zephyr, such as
:kconfig:`CONFIG_PM`, :kconfig:`CONFIG_PM_DEVICE`.
:kconfig:option:`CONFIG_PM`, :kconfig:option:`CONFIG_PM_DEVICE`.

When system power management is turned on (CONFIG_PM=y),
sleep state 2 (standby mode) is allowed, and polling is used to retrieve input
Expand Down
8 changes: 4 additions & 4 deletions boards/arm/cc3220sf_launchxl/doc/index.rst
Expand Up @@ -244,7 +244,7 @@ It is available as a Zephyr Wi-Fi device driver in
Usage:
======

Set :kconfig:`CONFIG_WIFI_SIMPLELINK` and :kconfig:`CONFIG_WIFI` to ``y``
Set :kconfig:option:`CONFIG_WIFI_SIMPLELINK` and :kconfig:option:`CONFIG_WIFI` to ``y``
to enable Wi-Fi.
See :zephyr_file:`samples/net/wifi/boards/cc3220sf_launchxl.conf`.

Expand Down Expand Up @@ -272,14 +272,14 @@ Secure Socket Offload

The SimpleLink Wi-Fi driver provides socket operations to the Zephyr socket
offload point, enabling Zephyr BSD socket API calls to be directed to the
SimpleLink Wi-Fi driver, by setting :kconfig:`CONFIG_NET_SOCKETS_OFFLOAD`
SimpleLink Wi-Fi driver, by setting :kconfig:option:`CONFIG_NET_SOCKETS_OFFLOAD`
to ``y``.

Secure socket (TLS) communication is handled as part of the socket APIs,
and enabled by:

- setting both :kconfig:`CONFIG_NET_SOCKETS_SOCKOPT_TLS`
and :kconfig:`CONFIG_TLS_CREDENTIAL_FILENAMES` to ``y``,
- setting both :kconfig:option:`CONFIG_NET_SOCKETS_SOCKOPT_TLS`
and :kconfig:option:`CONFIG_TLS_CREDENTIAL_FILENAMES` to ``y``,
- using the TI Uniflash tool to program the required certificates and
keys to the secure flash filesystem, and enabling the TI Trusted
Root-Certificate Catalog.
Expand Down
8 changes: 4 additions & 4 deletions boards/arm/cc3235sf_launchxl/doc/index.rst
Expand Up @@ -244,7 +244,7 @@ It is available as a Zephyr Wi-Fi device driver in
Usage:
======

Set :kconfig:`CONFIG_WIFI_SIMPLELINK` and :kconfig:`CONFIG_WIFI` to ``y``
Set :kconfig:option:`CONFIG_WIFI_SIMPLELINK` and :kconfig:option:`CONFIG_WIFI` to ``y``
to enable Wi-Fi.
See :zephyr_file:`samples/net/wifi/boards/cc3235sf_launchxl.conf`.

Expand Down Expand Up @@ -272,14 +272,14 @@ Secure Socket Offload

The SimpleLink Wi-Fi driver provides socket operations to the Zephyr socket
offload point, enabling Zephyr BSD socket API calls to be directed to the
SimpleLink Wi-Fi driver, by setting :kconfig:`CONFIG_NET_SOCKETS_OFFLOAD`
SimpleLink Wi-Fi driver, by setting :kconfig:option:`CONFIG_NET_SOCKETS_OFFLOAD`
to ``y``.

Secure socket (TLS) communication is handled as part of the socket APIs,
and enabled by:

- setting both :kconfig:`CONFIG_NET_SOCKETS_SOCKOPT_TLS`
and :kconfig:`CONFIG_TLS_CREDENTIAL_FILENAMES` to ``y``,
- setting both :kconfig:option:`CONFIG_NET_SOCKETS_SOCKOPT_TLS`
and :kconfig:option:`CONFIG_TLS_CREDENTIAL_FILENAMES` to ``y``,
- using the TI Uniflash tool to program the required certificates and
keys to the secure flash filesystem, and enabling the TI Trusted
Root-Certificate Catalog.
Expand Down
4 changes: 2 additions & 2 deletions boards/arm/gd32f350r_eval/doc/index.rst
Expand Up @@ -57,10 +57,10 @@ The board configuration supports the following hardware features:
- N/A
- N/A
* - USART
- :kconfig:`CONFIG_SERIAL`
- :kconfig:option:`CONFIG_SERIAL`
- :dtcompatible:`gd,gd32-usart`
* - PINMUX
- :kconfig:`CONFIG_PINCTRL`
- :kconfig:option:`CONFIG_PINCTRL`
- :dtcompatible:`gd,gd32-pinctrl-af`

Serial Port
Expand Down
14 changes: 7 additions & 7 deletions boards/arm/gd32f450i_eval/doc/index.rst
Expand Up @@ -60,31 +60,31 @@ The board configuration supports the following hardware features:
- Kconfig option
- Devicetree compatible
* - EXTI
- :kconfig:`CONFIG_GD32_EXTI`
- :kconfig:option:`CONFIG_GD32_EXTI`
- :dtcompatible:`gd,gd32-exti`
* - GPIO
- :kconfig:`CONFIG_GPIO`
- :kconfig:option:`CONFIG_GPIO`
- :dtcompatible:`gd,gd32-gpio`
* - NVIC
- N/A
- :dtcompatible:`arm,v7m-nvic`
* - PWM
- :kconfig:`CONFIG_PWM`
- :kconfig:option:`CONFIG_PWM`
- :dtcompatible:`gd,gd32-pwm`
* - SYSTICK
- N/A
- N/A
* - USART
- :kconfig:`CONFIG_SERIAL`
- :kconfig:option:`CONFIG_SERIAL`
- :dtcompatible:`gd,gd32-usart`
* - DAC
- :kconfig:`CONFIG_DAC`
- :kconfig:option:`CONFIG_DAC`
- :dtcompatible:`gd,gd32-dac`
* - I2C
- :kconfig:`CONFIG_I2C`
- :kconfig:option:`CONFIG_I2C`
- :dtcompatible:`gd,gd32-i2c`
* - EEPROM
- :kconfig:`CONFIG_EEPROM`
- :kconfig:option:`CONFIG_EEPROM`
- :dtcompatible:`atmel,at24`

Serial Port
Expand Down
2 changes: 1 addition & 1 deletion boards/arm/mimxrt1050_evk/doc/index.rst
Expand Up @@ -377,7 +377,7 @@ Troubleshooting

If the debug probe fails to connect with the following error, it's possible
that the boot header in HyperFlash is invalid or corrupted. The boot header is
configured by :kconfig:`CONFIG_NXP_IMX_RT_BOOT_HEADER`.
configured by :kconfig:option:`CONFIG_NXP_IMX_RT_BOOT_HEADER`.

.. code-block:: console

Expand Down
2 changes: 1 addition & 1 deletion boards/arm/mimxrt1060_evk/doc/index.rst
Expand Up @@ -374,7 +374,7 @@ Troubleshooting

If the debug probe fails to connect with the following error, it's possible
that the boot header in QSPI flash is invalid or corrupted. The boot header is
configured by :kconfig:`CONFIG_NXP_IMX_RT_BOOT_HEADER`.
configured by :kconfig:option:`CONFIG_NXP_IMX_RT_BOOT_HEADER`.

.. code-block:: console

Expand Down
2 changes: 1 addition & 1 deletion boards/arm/mimxrt1064_evk/doc/index.rst
Expand Up @@ -375,7 +375,7 @@ Troubleshooting

If the debug probe fails to connect with the following error, it's possible
that the boot header in QSPI flash is invalid or corrupted. The boot header is
configured by :kconfig:`CONFIG_NXP_IMX_RT_BOOT_HEADER`.
configured by :kconfig:option:`CONFIG_NXP_IMX_RT_BOOT_HEADER`.

.. code-block:: console

Expand Down
2 changes: 1 addition & 1 deletion boards/arm/nrf52840dongle_nrf52840/doc/index.rst
Expand Up @@ -264,7 +264,7 @@ name.
.. note::

This board supports building other Zephyr applications for flashing with
MCUboot in this way also. Just make sure :kconfig:`CONFIG_BOOTLOADER_MCUBOOT`
MCUboot in this way also. Just make sure :kconfig:option:`CONFIG_BOOTLOADER_MCUBOOT`
is set when building your application. For example, to compile blinky for
loading by MCUboot, use this:

Expand Down
6 changes: 3 additions & 3 deletions boards/arm/rpi_pico/doc/index.rst
Expand Up @@ -52,13 +52,13 @@ hardware features:
- N/A
- :dtcompatible:`arm,v6m-nvic`
* - UART
- :kconfig:`CONFIG_SERIAL`
- :kconfig:option:`CONFIG_SERIAL`
- :dtcompatible:`rpi,pico-uart`
* - GPIO
- :kconfig:`CONFIG_GPIO`
- :kconfig:option:`CONFIG_GPIO`
- :dtcompatible:`rpi,pico-gpio`
* - I2C
- :kconfig:`CONFIG_I2C`
- :kconfig:option:`CONFIG_I2C`
- :dtcompatible:`rpi,pico-i2c`

Programming and Debugging
Expand Down