From bcfbcc00afc841d509539ccd4ccf451bfc5b89fb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Benjamin=20Cab=C3=A9?= Date: Mon, 21 Oct 2024 15:24:59 +0200 Subject: [PATCH] boards: qemu: adopt new zephyr:board directive and role MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This updates the documentation of all the Qemu boards to use the new `zephyr:board::` directive. Signed-off-by: Benjamin Cabé --- boards/qemu/arc/doc/index.rst | 5 +---- boards/qemu/cortex_a53/doc/index.rst | 5 +---- boards/qemu/cortex_m0/doc/index.rst | 5 +---- boards/qemu/cortex_m3/doc/index.rst | 5 +---- boards/qemu/cortex_r5/doc/index.rst | 5 +---- boards/qemu/kvm_arm64/doc/index.rst | 5 +---- boards/qemu/leon3/doc/index.rst | 5 +---- boards/qemu/malta/doc/index.rst | 5 +---- boards/qemu/nios2/doc/index.rst | 5 +---- boards/qemu/riscv32/doc/index.rst | 5 +---- boards/qemu/riscv32_xip/doc/index.rst | 5 +---- boards/qemu/riscv32e/board.yml | 2 +- boards/qemu/riscv32e/doc/index.rst | 5 +---- boards/qemu/riscv64/doc/index.rst | 5 +---- boards/qemu/x86/doc/index.rst | 5 +---- boards/qemu/xtensa/doc/index.rst | 5 +---- doc/build/dts/howtos.rst | 3 ++- doc/connectivity/networking/api/gptp.rst | 2 +- doc/develop/west/build-flash-debug.rst | 4 ++-- doc/services/debugging/coredump.rst | 2 +- samples/subsys/llext/modules/README.rst | 4 ++-- 21 files changed, 24 insertions(+), 68 deletions(-) diff --git a/boards/qemu/arc/doc/index.rst b/boards/qemu/arc/doc/index.rst index 0aef5d8dc39..1c38701b22e 100644 --- a/boards/qemu/arc/doc/index.rst +++ b/boards/qemu/arc/doc/index.rst @@ -1,7 +1,4 @@ -.. _qemu_arc: - -ARCv2 & ARCv3 Emulation (QEMU) -############################### +.. zephyr:board:: qemu_arc Overview ******** diff --git a/boards/qemu/cortex_a53/doc/index.rst b/boards/qemu/cortex_a53/doc/index.rst index 424d6e5f874..d6e2e307b09 100644 --- a/boards/qemu/cortex_a53/doc/index.rst +++ b/boards/qemu/cortex_a53/doc/index.rst @@ -1,7 +1,4 @@ -.. _qemu_cortex_a53: - -ARM Cortex-A53 Emulation (QEMU) -############################### +.. zephyr:board:: qemu_cortex_a53 Overview ******** diff --git a/boards/qemu/cortex_m0/doc/index.rst b/boards/qemu/cortex_m0/doc/index.rst index 7035f57b07f..e091ace42a7 100644 --- a/boards/qemu/cortex_m0/doc/index.rst +++ b/boards/qemu/cortex_m0/doc/index.rst @@ -1,7 +1,4 @@ -.. _qemu_cortex_m0: - -ARM Cortex-M0 Emulation (QEMU) -############################## +.. zephyr:board:: qemu_cortex_m0 Overview ******** diff --git a/boards/qemu/cortex_m3/doc/index.rst b/boards/qemu/cortex_m3/doc/index.rst index f07f6bf2166..96eb19bc375 100644 --- a/boards/qemu/cortex_m3/doc/index.rst +++ b/boards/qemu/cortex_m3/doc/index.rst @@ -1,7 +1,4 @@ -.. _qemu_cortex_m3: - -ARM Cortex-M3 Emulation (QEMU) -############################## +.. zephyr:board:: qemu_cortex_m3 Overview ******** diff --git a/boards/qemu/cortex_r5/doc/index.rst b/boards/qemu/cortex_r5/doc/index.rst index c566e5d4c04..9d385b5a578 100644 --- a/boards/qemu/cortex_r5/doc/index.rst +++ b/boards/qemu/cortex_r5/doc/index.rst @@ -1,7 +1,4 @@ -.. _qemu_cortex_r5: - -ARM Cortex-R5 Emulation (QEMU) -############################## +.. zephyr:board:: qemu_cortex_r5 Overview ******** diff --git a/boards/qemu/kvm_arm64/doc/index.rst b/boards/qemu/kvm_arm64/doc/index.rst index 79eabb5c50f..e1341211e46 100644 --- a/boards/qemu/kvm_arm64/doc/index.rst +++ b/boards/qemu/kvm_arm64/doc/index.rst @@ -1,7 +1,4 @@ -.. _qemu_kvm_arm64: - -ARM AArch64 Virt KVM Emulation (QEMU) -##################################### +.. zephyr:board:: qemu_kvm_arm64 Overview ******** diff --git a/boards/qemu/leon3/doc/index.rst b/boards/qemu/leon3/doc/index.rst index 4e0599697fd..32a85ebbc5a 100644 --- a/boards/qemu/leon3/doc/index.rst +++ b/boards/qemu/leon3/doc/index.rst @@ -1,7 +1,4 @@ -.. _qemu_leon3: - -LEON3 Emulation (QEMU) -###################### +.. zephyr:board:: qemu_leon3 Overview ******** diff --git a/boards/qemu/malta/doc/index.rst b/boards/qemu/malta/doc/index.rst index 014d2ae9c78..f10dcc8c8df 100644 --- a/boards/qemu/malta/doc/index.rst +++ b/boards/qemu/malta/doc/index.rst @@ -1,7 +1,4 @@ -.. _qemu_malta: - -MIPS Malta Emulation (QEMU) -########################### +.. zephyr:board:: qemu_malta Overview ******** diff --git a/boards/qemu/nios2/doc/index.rst b/boards/qemu/nios2/doc/index.rst index 9dcef10a451..81717ab91b4 100644 --- a/boards/qemu/nios2/doc/index.rst +++ b/boards/qemu/nios2/doc/index.rst @@ -1,7 +1,4 @@ -.. _qemu_nios2: - -Altera Nios-II Emulation (QEMU) -############################### +.. zephyr:board:: qemu_nios2 Overview ******** diff --git a/boards/qemu/riscv32/doc/index.rst b/boards/qemu/riscv32/doc/index.rst index cf33745e198..ef2e3f91623 100644 --- a/boards/qemu/riscv32/doc/index.rst +++ b/boards/qemu/riscv32/doc/index.rst @@ -1,7 +1,4 @@ -.. _qemu_riscv32: - -RISCV32 Emulation (QEMU) -######################## +.. zephyr:board:: qemu_riscv32 Overview ******** diff --git a/boards/qemu/riscv32_xip/doc/index.rst b/boards/qemu/riscv32_xip/doc/index.rst index 4cc4f30522f..aea547ff75d 100644 --- a/boards/qemu/riscv32_xip/doc/index.rst +++ b/boards/qemu/riscv32_xip/doc/index.rst @@ -1,7 +1,4 @@ -.. _qemu_riscv32_xip: - -RISCV32 XIP Emulation (QEMU) -############################ +.. zephyr:board:: qemu_riscv32_xip Overview ******** diff --git a/boards/qemu/riscv32e/board.yml b/boards/qemu/riscv32e/board.yml index e4b41d79f3e..e720485ff43 100644 --- a/boards/qemu/riscv32e/board.yml +++ b/boards/qemu/riscv32e/board.yml @@ -1,6 +1,6 @@ board: name: qemu_riscv32e - full_name: QEMU Emulation for RISCV32E Emulation + full_name: QEMU Emulation for RISCV32E vendor: qemu socs: - name: qemu_virt_riscv32e diff --git a/boards/qemu/riscv32e/doc/index.rst b/boards/qemu/riscv32e/doc/index.rst index 15981f00c8e..6b47c3a3639 100644 --- a/boards/qemu/riscv32e/doc/index.rst +++ b/boards/qemu/riscv32e/doc/index.rst @@ -1,7 +1,4 @@ -.. _qemu_riscv32e: - -RISCV32E Emulation (QEMU) -######################### +.. zephyr:board:: qemu_riscv32e Overview ******** diff --git a/boards/qemu/riscv64/doc/index.rst b/boards/qemu/riscv64/doc/index.rst index e58df91f679..79d4f6d155f 100644 --- a/boards/qemu/riscv64/doc/index.rst +++ b/boards/qemu/riscv64/doc/index.rst @@ -1,7 +1,4 @@ -.. _qemu_riscv64: - -RISCV64 Emulation (QEMU) -######################## +.. zephyr:board:: qemu_riscv64 Overview ******** diff --git a/boards/qemu/x86/doc/index.rst b/boards/qemu/x86/doc/index.rst index 2fdba13bc09..98e0098d39a 100644 --- a/boards/qemu/x86/doc/index.rst +++ b/boards/qemu/x86/doc/index.rst @@ -1,7 +1,4 @@ -.. _qemu_x86: - -X86 Emulation (QEMU) -#################### +.. zephyr:board:: qemu_x86 Overview ******** diff --git a/boards/qemu/xtensa/doc/index.rst b/boards/qemu/xtensa/doc/index.rst index f0ec7e9deec..741e0569b7f 100644 --- a/boards/qemu/xtensa/doc/index.rst +++ b/boards/qemu/xtensa/doc/index.rst @@ -1,7 +1,4 @@ -.. _qemu_xtensa: - -Xtensa Emulation (QEMU) -####################### +.. zephyr:board:: qemu_xtensa Overview ******** diff --git a/doc/build/dts/howtos.rst b/doc/build/dts/howtos.rst index 5bd4df9fcbe..b132e7ff1a7 100644 --- a/doc/build/dts/howtos.rst +++ b/doc/build/dts/howtos.rst @@ -26,7 +26,8 @@ application and open the :file:`zephyr.dts` file in the build directory. You can build :zephyr:code-sample:`hello_world` to see the "base" devicetree for your board without any additional changes from :ref:`overlay files `. -For example, using the :ref:`qemu_cortex_m3` board to build :zephyr:code-sample:`hello_world`: +For example, using the :zephyr:board:`qemu_cortex_m3` board to build +:zephyr:code-sample:`hello_world`: .. code-block:: sh diff --git a/doc/connectivity/networking/api/gptp.rst b/doc/connectivity/networking/api/gptp.rst index 772e6f099d1..e4fab0dcdaf 100644 --- a/doc/connectivity/networking/api/gptp.rst +++ b/doc/connectivity/networking/api/gptp.rst @@ -42,7 +42,7 @@ Boards supported: - :zephyr:board:`sam_e70_xplained` - :ref:`native_sim` (only usable for simple testing, limited capabilities due to lack of hardware clock) -- :ref:`qemu_x86` (emulated, limited capabilities due to lack of hardware clock) +- :zephyr:board:`qemu_x86` (emulated, limited capabilities due to lack of hardware clock) Enabling the stack ****************** diff --git a/doc/develop/west/build-flash-debug.rst b/doc/develop/west/build-flash-debug.rst index 36a4d5ddc51..c45a4551843 100644 --- a/doc/develop/west/build-flash-debug.rst +++ b/doc/develop/west/build-flash-debug.rst @@ -145,8 +145,8 @@ Setting the Build System Target To specify the build system target to run, use ``--target`` (or ``-t``). For example, on host platforms with QEMU, you can use the ``run`` target to -build and run the :zephyr:code-sample:`hello_world` sample for the emulated :ref:`qemu_x86 -` board in one command:: +build and run the :zephyr:code-sample:`hello_world` sample for the emulated +:zephyr:board:`qemu_x86 ` board in one command:: west build -b qemu_x86 -t run samples/hello_world diff --git a/doc/services/debugging/coredump.rst b/doc/services/debugging/coredump.rst index 3777cfd266a..a5a84b96ccd 100644 --- a/doc/services/debugging/coredump.rst +++ b/doc/services/debugging/coredump.rst @@ -90,7 +90,7 @@ Example ------- This example uses the log module backend tied to serial console. -This was done on :ref:`qemu_x86` where a null pointer was dereferenced. +This was done on :zephyr:board:`qemu_x86` where a null pointer was dereferenced. This is the core dump log from the serial console, and is stored in :file:`coredump.log`: diff --git a/samples/subsys/llext/modules/README.rst b/samples/subsys/llext/modules/README.rst index 4149dffab25..a4c5bf64078 100644 --- a/samples/subsys/llext/modules/README.rst +++ b/samples/subsys/llext/modules/README.rst @@ -30,8 +30,8 @@ Requirements ************ A board with a supported llext architecture and console. This can also be -executed in QEMU emulation on the :ref:`qemu_xtensa ` or -:ref:`qemu_cortex_r5 ` virtual boards. +executed in QEMU emulation on the :zephyr:board:`qemu_xtensa ` or +:zephyr:board:`qemu_cortex_r5 ` virtual boards. Building and running ********************