michaelh/zephyr
1
0
Fork 0
Code Releases Activity

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

Browse source 
This updates the documentation of all the Qemu boards
to use the new `zephyr:board::` directive.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This commit is contained in:
Benjamin Cabé 2024-10-21 15:24:59 +02:00 • committed by Carles Cufí
commit bcfbcc00af
21 changed files with 24 additions and 68 deletions
Download patch file Download diff file Expand all files Collapse all files

5
boards/qemu/arc/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _qemu_arc:
ARCv2 & ARCv3 Emulation (QEMU)
###############################
.. zephyr:board:: qemu_arc
Overview
********

5
boards/qemu/cortex_a53/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _qemu_cortex_a53:
ARM Cortex-A53 Emulation (QEMU)
###############################
.. zephyr:board:: qemu_cortex_a53
Overview
********

5
boards/qemu/cortex_m0/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _qemu_cortex_m0:
ARM Cortex-M0 Emulation (QEMU)
##############################
.. zephyr:board:: qemu_cortex_m0
Overview
********

5
boards/qemu/cortex_m3/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _qemu_cortex_m3:
ARM Cortex-M3 Emulation (QEMU)
##############################
.. zephyr:board:: qemu_cortex_m3
Overview
********

5
boards/qemu/cortex_r5/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _qemu_cortex_r5:
ARM Cortex-R5 Emulation (QEMU)
##############################
.. zephyr:board:: qemu_cortex_r5
Overview
********

5
boards/qemu/kvm_arm64/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _qemu_kvm_arm64:
ARM AArch64 Virt KVM Emulation (QEMU)
#####################################
.. zephyr:board:: qemu_kvm_arm64
Overview
********

5
boards/qemu/leon3/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _qemu_leon3:
LEON3 Emulation (QEMU)
######################
.. zephyr:board:: qemu_leon3
Overview
********

5
boards/qemu/malta/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _qemu_malta:
MIPS Malta Emulation (QEMU)
###########################
.. zephyr:board:: qemu_malta
Overview
********

5
boards/qemu/nios2/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _qemu_nios2:
Altera Nios-II Emulation (QEMU)
###############################
.. zephyr:board:: qemu_nios2
Overview
********

5
boards/qemu/riscv32/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _qemu_riscv32:
RISCV32 Emulation (QEMU)
########################
.. zephyr:board:: qemu_riscv32
Overview
********

5
boards/qemu/riscv32_xip/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _qemu_riscv32_xip:
RISCV32 XIP Emulation (QEMU)
############################
.. zephyr:board:: qemu_riscv32_xip
Overview
********

2
boards/qemu/riscv32e/board.yml
View file

@ -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

5
boards/qemu/riscv32e/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _qemu_riscv32e:
RISCV32E Emulation (QEMU)
#########################
.. zephyr:board:: qemu_riscv32e
Overview
********

5
boards/qemu/riscv64/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _qemu_riscv64:
RISCV64 Emulation (QEMU)
########################
.. zephyr:board:: qemu_riscv64
Overview
********

5
boards/qemu/x86/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _qemu_x86:
X86 Emulation (QEMU)
####################
.. zephyr:board:: qemu_x86
Overview
********

5
boards/qemu/xtensa/doc/index.rst
View file

@ -1,7 +1,4 @@
.. _qemu_xtensa:
Xtensa Emulation (QEMU)
#######################
.. zephyr:board:: qemu_xtensa
Overview
********

3
doc/build/dts/howtos.rst vendored
View file

@ -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

2
doc/connectivity/networking/api/gptp.rst
View file

@ -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
******************

4
doc/develop/west/build-flash-debug.rst
View file

@ -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

2
doc/services/debugging/coredump.rst
View file

@ -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`:

4
samples/subsys/llext/modules/README.rst
View file

@ -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
********************