boards: qemu: adopt new zephyr:board directive and role

kartben · carlescufi · commit bcfbcc00afc8 · 2024-10-24T17:51:15.000+02:00
This updates the documentation of all the Qemu boards
to use the new `zephyr:board::` directive.

Signed-off-by: Benjamin Cabé &lt;benjamin@zephyrproject.org&gt;
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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 <dt-input-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
@@ -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
@@ -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
-<qemu_x86>` board in one command::
+build and run the :zephyr:code-sample:`hello_world` sample for the emulated
+:zephyr:board:`qemu_x86 <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
@@ -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
@@ -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 <qemu_xtensa>` or
-:ref:`qemu_cortex_r5 <qemu_cortex_r5>` virtual boards.
+executed in QEMU emulation on the :zephyr:board:`qemu_xtensa <qemu_xtensa>` or
+:zephyr:board:`qemu_cortex_r5 <qemu_cortex_r5>` virtual boards.
 
 Building and running
 ********************
