doc: use proper pygment for .conf code-blocks

config file snippets should use "cfg" pygment to get proper highlighting
This commit updates all occurences where "kconfig" or other languages
were used.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This commit is contained in:
Benjamin Cabé 2024-06-18 14:54:12 +02:00 committed by Anas Nashif
parent 7adac57943
commit b4b623c26c
15 changed files with 30 additions and 28 deletions

View File

@ -172,7 +172,7 @@ directly into RAM and then boot it from the __start symbol.
In order for this to work, your entire kernel must be located in RAM. Make sure
the following config options are disabled:
.. code-block:: console
.. code-block:: cfg
CONFIG_XIP=n
CONFIG_INCLUDE_RESET_VECTOR=n
@ -265,7 +265,7 @@ In order for this to work, execute-in-place must be disabled, since the GDB
'load' command can only put text and data in RAM. Ensure this is in your
configuration:
.. code-block:: console
.. code-block:: cfg
CONFIG_XIP=n

View File

@ -178,7 +178,7 @@ change it to
In your prj.conf overwrite the configuration like this for the **DDR** memory
region:
.. code-block:: console
.. code-block:: cfg
CONFIG_CODE_DDR=y
CONFIG_CODE_ITCM=n

View File

@ -33,7 +33,7 @@ Using SLIRP with Zephyr
In order to use SLIRP with Zephyr, the user has to set the Kconfig option to
enable User Networking.
.. code-block:: console
.. code-block:: cfg
CONFIG_NET_QEMU_USER=y
@ -58,7 +58,7 @@ offloads this to the user, and expects that they will provide arguments
based on requirements. For this, there is a Kconfig string which can be
populated by the user.
.. code-block:: console
.. code-block:: cfg
CONFIG_NET_QEMU_USER_EXTRA_ARGS="net=192.168.0.0/24,hostfwd=tcp::8080-:8080"

View File

@ -639,7 +639,7 @@ Application configuration options are usually set in :file:`prj.conf` in the
application directory. For example, C++ support could be enabled with this
assignment:
.. code-block:: none
.. code-block:: cfg
CONFIG_CPP=y
@ -666,7 +666,7 @@ marked ``[EXPERIMENTAL]`` in their Kconfig title.
The :kconfig:option:`CONFIG_WARN_EXPERIMENTAL` setting can be used to enable warnings
at CMake configure time if any experimental feature is enabled.
.. code-block:: none
.. code-block:: cfg
CONFIG_WARN_EXPERIMENTAL=y

View File

@ -160,7 +160,7 @@ which can be very useful if the UART (through USB CDC ACM) is already being used
a purpose different than logging (such as HCI traffic in the hci_uart application).
To use RTT, you will first need to enable it by adding the following lines in your ``.conf`` file:
.. code-block:: text
.. code-block:: cfg
CONFIG_USE_SEGGER_RTT=y
CONFIG_RTT_CONSOLE=y
@ -178,7 +178,7 @@ with the RTT one if they are enabled by default in the particular sample or
application you are running. For example, to disable the UART console,
add this to your ``.conf`` file:
.. code-block:: console
.. code-block:: cfg
CONFIG_UART_CONSOLE=n

View File

@ -173,7 +173,7 @@ so:
On the host application, some config options need to be used to select the H4
driver instead of the built-in controller:
.. code-block:: kconfig
.. code-block:: cfg
CONFIG_BT_HCI=y
CONFIG_BT_CTLR=n

View File

@ -173,7 +173,7 @@ so:
On the host application, some config options need to be used to select the H5
driver instead of the built-in controller:
.. code-block:: kconfig
.. code-block:: cfg
CONFIG_BT_HCI=y
CONFIG_BT_CTLR=n

View File

@ -139,7 +139,7 @@ so:
On the host application, some config options need to be used to select the H4
driver instead of the built-in controller:
.. code-block:: kconfig
.. code-block:: cfg
CONFIG_BT_HCI=y
CONFIG_BT_CTLR=n

View File

@ -98,7 +98,7 @@ It is recommended that you copy and modify one of the two TensorFlow
samples when creating your own TensorFlow project. To build with
TensorFlow, you must enable the below Kconfig options in your :file:`prj.conf`:
.. code-block:: kconfig
.. code-block:: cfg
CONFIG_CPP=y
CONFIG_REQUIRES_FULL_LIBC=y
@ -108,7 +108,7 @@ Note that the CMSIS-NN kernel sample demonstrates how to use CMSIS-NN optimized
TensorFlow Lite Micro, in that is sets below Kconfig option. Note also that this
Kconfig option is only set for Arm Cortex-M cores, i.e. option CPU_CORTEX_M is set.
.. code-block:: kconfig
.. code-block:: cfg
CONFIG_TENSORFLOW_LITE_MICRO_CMSIS_NN_KERNELS=y

View File

@ -111,7 +111,7 @@ It is recommended that you copy and modify one of the two TensorFlow
samples when creating your own TensorFlow project. To build with
TensorFlow, you must enable the below Kconfig options in your :file:`prj.conf`:
.. code-block:: kconfig
.. code-block:: cfg
CONFIG_CPP=y
CONFIG_REQUIRES_FULL_LIBC=y

View File

@ -76,7 +76,7 @@ Sample overlay file
This is the overlay template for Azure IoT hub and other details:
.. code-block:: console
.. code-block:: cfg
CONFIG_SAMPLE_CLOUD_AZURE_USERNAME="<username>"
CONFIG_SAMPLE_CLOUD_AZURE_PASSWORD="<SAS token>"

View File

@ -47,7 +47,7 @@ In this sample application, both static or DHCPv4 IP addresses are supported.
Static IP addresses are specified in the project configuration file,
for example:
.. code-block:: console
.. code-block:: cfg
CONFIG_NET_CONFIG_MY_IPV6_ADDR="2001:db8::1"
CONFIG_NET_CONFIG_PEER_IPV6_ADDR="2001:db8::2"
@ -75,7 +75,7 @@ the appropriate 'prj.conf' file and update the DNS server addresses. For
instance, if using the usual IP addresses assigned to testing, update them
to the following values:
.. code-block:: console
.. code-block:: cfg
CONFIG_DNS_SERVER1="192.0.2.2:5353"
CONFIG_DNS_SERVER2="[2001:db8::2]:5353"
@ -113,7 +113,7 @@ LLMNR Responder
If you want Zephyr to respond to a LLMNR DNS request that Windows host is
sending, then following config options could be set:
.. code-block:: console
.. code-block:: cfg
CONFIG_NET_HOSTNAME_ENABLE=y
CONFIG_NET_HOSTNAME="zephyr-device"

View File

@ -84,9 +84,9 @@ following macros to specify those values:
Max number of MQTT PUBLISH iterations is defined in Kconfig:
.. code-block:: c
.. code-block:: cfg
CONFIG_NET_SAMPLE_APP_MAX_ITERATIONS 5
CONFIG_NET_SAMPLE_APP_MAX_ITERATIONS=5
On your Linux host computer, open a terminal window, locate the source code
of this sample application (i.e., :zephyr_file:`samples/net/mqtt_publisher`) and type:
@ -202,9 +202,9 @@ Sample output
This is the output from the FRDM UART console, with:
.. code-block:: c
.. code-block:: cfg
CONFIG_NET_SAMPLE_APP_MAX_ITERATIONS 5
CONFIG_NET_SAMPLE_APP_MAX_ITERATIONS=5
.. code-block:: console

View File

@ -26,7 +26,7 @@ Building and Running
For configuring the remote IPv6 syslog server, set the following
variables in prj.conf file:
.. code-block:: console
.. code-block:: cfg
CONFIG_LOG_BACKEND_NET=y
CONFIG_LOG_BACKEND_NET_SERVER="[2001:db8::2]:514"

View File

@ -74,11 +74,13 @@ This sample will only build on a Linux or macOS development system
TF-M BL2 logs
=============
Add the following to ``prj.conf`` to see the logs from TF-M BL2:
.. code-block:: bash
CONFIG_TFM_BL2=y
CONFIG_TFM_CMAKE_BUILD_TYPE_DEBUG=y
Add the following to ``prj.conf`` to see the logs from TF-M BL2:
.. code-block:: cfg
CONFIG_TFM_BL2=y
CONFIG_TFM_CMAKE_BUILD_TYPE_DEBUG=y
On MPS2+ AN521:
===============