[PATCH v2 4/7] doc: make pdfdocs: Ensure SVG files are converted to PDF before the compilation of *.tex files
Adriano Carvalho
adrianocarvalho.pt at gmail.com
Mon Oct 6 00:10:11 CEST 2025
SVG files are not handled directly in the *.tex files. This commit
replaces all instances of ".. image::" with ".. kernel-figure::". With
this, the kfigure sphinx extension (already present) ensures that SVG
files are converted to PDF before the compilation of *.tex files.
If I don't do this, this is what I get with
docker.io/trini/u-boot-gitlab-ci-runner:jammy-20250714-25Jul2025:
uboot at 35c89b9ab70e:~/u-boot$ make pdfdocs
[...]
xelatex 'android.tex'
[...]
Output written on android.pdf (28 pages).
[...]
xelatex 'api.tex'
[...]
Output written on api.pdf (431 pages).
[...]
xelatex 'arch.tex'
[...]
Output written on arch.pdf (62 pages).
[...]
xelatex 'board.tex'
[...]
[152]
Chapter 14.
! LaTeX Error: Cannot determine size of graphic in boot_diagram_am62.svg (no Bo
undingBox).
See the LaTeX manual or LaTeX Companion for explanation.
Type H <return> for immediate help.
...
l.11422 ...ncludegraphics{{boot_diagram_am62}.svg}
?
! Emergency stop.
...
[...]
Output written on board.pdf (156 pages).
Transcript written on board.log.
make[2]: *** [Makefile:29: board.pdf] Error 1
make[1]: *** [doc/Makefile:95: pdfdocs] Error 2
make: *** [Makefile:2687: pdfdocs] Error 2
NOTE: This won't completely fix the pdfdocs target. See next commit(s).
Signed-off-by: Adriano Carvalho <adrianocarvalho.pt at gmail.com>
---
doc/board/beagle/am62x_beagleplay.rst | 8 ++++----
doc/board/beagle/am67a_beagley_ai.rst | 6 +++---
doc/board/beagle/j721e_beagleboneai64.rst | 10 +++++-----
doc/board/samsung/e850-96.rst | 2 +-
doc/board/ti/am62ax_sk.rst | 6 +++---
doc/board/ti/am62px_sk.rst | 8 ++++----
doc/board/ti/am62x_sk.rst | 8 ++++----
doc/board/ti/am64x_evm.rst | 8 ++++----
doc/board/ti/am65x_evm.rst | 12 ++++++------
doc/board/ti/j7200_evm.rst | 10 +++++-----
doc/board/ti/j721e_evm.rst | 10 +++++-----
doc/board/ti/j721s2_evm.rst | 6 +++---
doc/board/ti/j722s_evm.rst | 6 +++---
doc/board/ti/j784s4_evm.rst | 8 ++++----
doc/board/ti/k3.rst | 8 ++++----
doc/develop/memory.rst | 4 ++--
doc/develop/trace.rst | 10 +++++-----
tools/patman/patman.rst | 2 +-
18 files changed, 66 insertions(+), 66 deletions(-)
diff --git a/doc/board/beagle/am62x_beagleplay.rst b/doc/board/beagle/am62x_beagleplay.rst
index bc71aabaac3..8188f0b41c9 100644
--- a/doc/board/beagle/am62x_beagleplay.rst
+++ b/doc/board/beagle/am62x_beagleplay.rst
@@ -23,7 +23,7 @@ Boot Flow:
----------
Below is the pictorial representation of boot flow:
-.. image:: ../ti/img/boot_diagram_am62.svg
+.. kernel-figure:: ../ti/img/boot_diagram_am62.svg
:alt: Boot flow diagram
- On this platform, 'TI Foundational Security' (TIFS) functions as the
@@ -85,12 +85,12 @@ Image formats
- tiboot3.bin
-.. image:: ../ti/img/multi_cert_tiboot3.bin.svg
+.. kernel-figure:: ../ti/img/multi_cert_tiboot3.bin.svg
:alt: tiboot3.bin image format
- tispl.bin
-.. image:: ../ti/img/tifsstub_dm_tispl.bin.svg
+.. kernel-figure:: ../ti/img/tifsstub_dm_tispl.bin.svg
:alt: tispl.bin image format
Additional hardware for U-Boot development
@@ -172,7 +172,7 @@ Area (UDA) hardware partition of the eMMC. These components can vary
significantly in size. The choice of keeping tiboot3.bin in boot0 or
boot1 partition depends on A/B update requirements.
-.. image:: img/beagleplay_emmc.svg
+.. kernel-figure:: img/beagleplay_emmc.svg
:alt: eMMC partitions and boot file organization for BeaglePlay
The following are the steps from Linux shell to program eMMC:
diff --git a/doc/board/beagle/am67a_beagley_ai.rst b/doc/board/beagle/am67a_beagley_ai.rst
index 3d2fc4a3195..7113029f0ff 100644
--- a/doc/board/beagle/am67a_beagley_ai.rst
+++ b/doc/board/beagle/am67a_beagley_ai.rst
@@ -23,7 +23,7 @@ Boot Flow:
----------
Below is the pictorial representation of boot flow:
-.. image:: ../ti/img/boot_diagram_k3_current.svg
+.. kernel-figure:: ../ti/img/boot_diagram_k3_current.svg
:alt: Boot flow diagram
- On this platform, 'TI Foundational Security' (TIFS) functions as the
@@ -84,12 +84,12 @@ Image formats
- tiboot3.bin
-.. image:: ../ti/img/multi_cert_tiboot3.bin.svg
+.. kernel-figure:: ../ti/img/multi_cert_tiboot3.bin.svg
:alt: tiboot3.bin image format
- tispl.bin
-.. image:: ../ti/img/tifsstub_dm_tispl.bin.svg
+.. kernel-figure:: ../ti/img/tifsstub_dm_tispl.bin.svg
:alt: tispl.bin image format
Additional hardware for U-Boot development
diff --git a/doc/board/beagle/j721e_beagleboneai64.rst b/doc/board/beagle/j721e_beagleboneai64.rst
index a57bc743569..94bcce75a42 100644
--- a/doc/board/beagle/j721e_beagleboneai64.rst
+++ b/doc/board/beagle/j721e_beagleboneai64.rst
@@ -26,7 +26,7 @@ Boot Flow:
----------
Below is the pictorial representation of boot flow:
-.. image:: ../ti/img/boot_diagram_j721e.svg
+.. kernel-figure:: ../ti/img/boot_diagram_j721e.svg
:alt: Boot flow diagram
- On this platform, DMSC runs 'TI Foundational Security' (TIFS) which
@@ -92,17 +92,17 @@ Image formats
- tiboot3.bin
-.. image:: ../ti/img/no_multi_cert_tiboot3.bin.svg
+.. kernel-figure:: ../ti/img/no_multi_cert_tiboot3.bin.svg
:alt: tiboot3.bin image format
- tispl.bin
-.. image:: ../ti/img/dm_tispl.bin.svg
+.. kernel-figure:: ../ti/img/dm_tispl.bin.svg
:alt: tispl.bin image format
- sysfw.itb
-.. image:: ../ti/img/sysfw.itb.svg
+.. kernel-figure:: ../ti/img/sysfw.itb.svg
:alt: sysfw.itb image format
Additional hardware for U-Boot development
@@ -184,7 +184,7 @@ Area (UDA) hardware partition of the eMMC. These components can vary
significantly in size. The choice of keeping tiboot3.bin in boot0 or
boot1 partition depends on A/B update requirements.
-.. image:: img/beagleplay_emmc.svg
+.. kernel-figure:: img/beagleplay_emmc.svg
:alt: eMMC partitions and boot file organization for BeagleBone AI-64
The following are the steps from Linux shell to program eMMC:
diff --git a/doc/board/samsung/e850-96.rst b/doc/board/samsung/e850-96.rst
index b435fa8b353..8e47dcbf5b6 100644
--- a/doc/board/samsung/e850-96.rst
+++ b/doc/board/samsung/e850-96.rst
@@ -28,7 +28,7 @@ Boot Flow
The boot path for Exynos850 is shown on the figure below.
-.. image:: img/exynos850-boot-architecture.svg
+.. kernel-figure:: img/exynos850-boot-architecture.svg
:alt: Exynos850 SoC boot flow
Legend:
diff --git a/doc/board/ti/am62ax_sk.rst b/doc/board/ti/am62ax_sk.rst
index 4dd998bcce9..8a45453c1a8 100644
--- a/doc/board/ti/am62ax_sk.rst
+++ b/doc/board/ti/am62ax_sk.rst
@@ -47,7 +47,7 @@ Boot Flow:
----------
Below is the pictorial representation of boot flow:
-.. image:: img/boot_diagram_am62.svg
+.. kernel-figure:: img/boot_diagram_am62.svg
:alt: Boot flow diagram
- Here TIFS acts as master and provides all the critical services. R5/A53
@@ -138,12 +138,12 @@ Image formats:
- tiboot3.bin
-.. image:: img/multi_cert_tiboot3.bin.svg
+.. kernel-figure:: img/multi_cert_tiboot3.bin.svg
:alt: tiboot3.bin image format
- tispl.bin
-.. image:: img/tifsstub_dm_tispl.bin.svg
+.. kernel-figure:: img/tifsstub_dm_tispl.bin.svg
:alt: tispl.bin image format
Switch Setting for Boot Mode
diff --git a/doc/board/ti/am62px_sk.rst b/doc/board/ti/am62px_sk.rst
index a07d6a4da45..dc54a47dbb4 100644
--- a/doc/board/ti/am62px_sk.rst
+++ b/doc/board/ti/am62px_sk.rst
@@ -55,7 +55,7 @@ Boot Flow:
The bootflow is exactly the same as all SoCs in the am62xxx extended SoC
family. Below is the pictorial representation:
-.. image:: img/boot_diagram_am62.svg
+.. kernel-figure:: img/boot_diagram_am62.svg
:alt: Boot flow diagram
- Here TIFS acts as master and provides all the critical services. R5/A53
@@ -152,12 +152,12 @@ Image formats:
- tiboot3.bin
-.. image:: img/multi_cert_tiboot3.bin.svg
+.. kernel-figure:: img/multi_cert_tiboot3.bin.svg
:alt: tiboot3.bin image format
- tispl.bin
-.. image:: img/tifsstub_dm_tispl.bin.svg
+.. kernel-figure:: img/tifsstub_dm_tispl.bin.svg
:alt: tispl.bin image format
OSPI:
@@ -181,7 +181,7 @@ over tftp and then flash those to OSPI at their respective addresses.
Flash layout for OSPI:
-.. image:: img/ospi_sysfw2.svg
+.. kernel-figure:: img/ospi_sysfw2.svg
:alt: OSPI flash partition layout
A53 SPL DDR Memory Layout
diff --git a/doc/board/ti/am62x_sk.rst b/doc/board/ti/am62x_sk.rst
index dab2970a85c..4ca668dfeab 100644
--- a/doc/board/ti/am62x_sk.rst
+++ b/doc/board/ti/am62x_sk.rst
@@ -46,7 +46,7 @@ Boot Flow:
----------
Below is the pictorial representation of boot flow:
-.. image:: img/boot_diagram_am62.svg
+.. kernel-figure:: img/boot_diagram_am62.svg
:alt: Boot flow diagram
- Here TIFS acts as master and provides all the critical services. R5/A53
@@ -174,12 +174,12 @@ Image formats:
- tiboot3.bin
-.. image:: img/multi_cert_tiboot3.bin.svg
+.. kernel-figure:: img/multi_cert_tiboot3.bin.svg
:alt: tiboot3.bin image format
- tispl.bin
-.. image:: img/tifsstub_dm_tispl.bin.svg
+.. kernel-figure:: img/tifsstub_dm_tispl.bin.svg
:alt: tispl.bin image format
OSPI:
@@ -203,7 +203,7 @@ over tftp and then flash those to OSPI at their respective addresses.
Flash layout for OSPI:
-.. image:: img/ospi_sysfw2.svg
+.. kernel-figure:: img/ospi_sysfw2.svg
:alt: OSPI flash partition layout
A53 SPL DDR Memory Layout
diff --git a/doc/board/ti/am64x_evm.rst b/doc/board/ti/am64x_evm.rst
index 65c4c456528..015b8cfb299 100644
--- a/doc/board/ti/am64x_evm.rst
+++ b/doc/board/ti/am64x_evm.rst
@@ -35,7 +35,7 @@ Boot Flow:
----------
Below is the pictorial representation of boot flow:
-.. image:: img/boot_diagram_am64.svg
+.. kernel-figure:: img/boot_diagram_am64.svg
:alt: Boot flow diagram
- Here TIFS acts as master and provides all the critical services. R5/A53
@@ -136,12 +136,12 @@ Image formats:
- tiboot3.bin
-.. image:: img/multi_cert_tiboot3.bin.svg
+.. kernel-figure:: img/multi_cert_tiboot3.bin.svg
:alt: tiboot3.bin image format
- tispl.bin
-.. image:: img/nodm_tispl.bin.svg
+.. kernel-figure:: img/nodm_tispl.bin.svg
:alt: tispl.bin image format
OSPI:
@@ -165,7 +165,7 @@ over tftp and then flash those to OSPI at their respective addresses.
Flash layout for OSPI:
-.. image:: img/ospi_sysfw-am64.svg
+.. kernel-figure:: img/ospi_sysfw-am64.svg
:alt: OSPI flash partition layout
Switch Setting for Boot Mode
diff --git a/doc/board/ti/am65x_evm.rst b/doc/board/ti/am65x_evm.rst
index 60b08ceebf0..7be4c6eaf44 100644
--- a/doc/board/ti/am65x_evm.rst
+++ b/doc/board/ti/am65x_evm.rst
@@ -45,7 +45,7 @@ applications. This should happen before running Linux.
3. In production boot flow, we might not like to use full U-Boot,
instead use Falcon boot flow to reduce boot time.
-.. image:: img/boot_diagram_am65.svg
+.. kernel-figure:: img/boot_diagram_am65.svg
:alt: Boot flow diagram
- Here DMSC acts as master and provides all the critical services. R5/A53
@@ -141,17 +141,17 @@ Image formats:
- tiboot3.bin
-.. image:: img/no_multi_cert_tiboot3.bin.svg
+.. kernel-figure:: img/no_multi_cert_tiboot3.bin.svg
:alt: tiboot3.bin image format
- tispl.bin
-.. image:: img/nodm_tispl.bin.svg
+.. kernel-figure:: img/nodm_tispl.bin.svg
:alt: tispl.bin image format
- sysfw.itb
-.. image:: img/sysfw.itb.svg
+.. kernel-figure:: img/sysfw.itb.svg
:alt: sysfw.itb image format
eMMC:
@@ -193,7 +193,7 @@ used:
eMMC layout:
-.. image:: img/emmc_am65x_evm_boot0.svg
+.. kernel-figure:: img/emmc_am65x_evm_boot0.svg
:alt: emmc boot partition layout
Kernel image and DT are expected to be present in the /boot folder of rootfs.
@@ -229,7 +229,7 @@ addresses.
Flash layout for OSPI:
-.. image:: img/ospi_sysfw.svg
+.. kernel-figure:: img/ospi_sysfw.svg
:alt: OSPI flash partition layout
Kernel Image and DT are expected to be present in the /boot folder of UBIFS
diff --git a/doc/board/ti/j7200_evm.rst b/doc/board/ti/j7200_evm.rst
index 4fd2aff8354..b6e285ec621 100644
--- a/doc/board/ti/j7200_evm.rst
+++ b/doc/board/ti/j7200_evm.rst
@@ -34,7 +34,7 @@ Boot Flow:
----------
Below is the pictorial representation of boot flow:
-.. image:: img/boot_diagram_k3_current.svg
+.. kernel-figure:: img/boot_diagram_k3_current.svg
:alt: Boot flow diagram
- Here DMSC acts as master and provides all the critical services. R5/A72
@@ -135,12 +135,12 @@ Image formats:
- tiboot3.bin
-.. image:: img/j7200_tiboot3.bin.svg
+.. kernel-figure:: img/j7200_tiboot3.bin.svg
:alt: tiboot3.bin image format
- tispl.bin
-.. image:: img/dm_tispl.bin.svg
+.. kernel-figure:: img/dm_tispl.bin.svg
:alt: tispl.bin image format
Switch Setting for Boot Mode
@@ -196,7 +196,7 @@ Current allocated size for tiboot3 size is 1MB, tispl is 2MB.
Size of u-boot.img is taken 4MB for refernece,
But this is subject to change depending upon atf, optee size
-.. image:: img/emmc_j7200_evm_boot01.svg
+.. kernel-figure:: img/emmc_j7200_evm_boot01.svg
:alt: Traditional eMMC boot partition layout
In case of UDA FS mode booting, following is layout.
@@ -204,7 +204,7 @@ In case of UDA FS mode booting, following is layout.
All boot images tiboot3.bin, tispl and u-boot should be written to
fat formatted UDA FS as file.
-.. image:: img/emmc_j7200_evm_udafs.svg
+.. kernel-figure:: img/emmc_j7200_evm_udafs.svg
:alt: eMMC UDA boot partition layout
In case of booting from eMMC, write above images into raw or UDA FS.
diff --git a/doc/board/ti/j721e_evm.rst b/doc/board/ti/j721e_evm.rst
index 41c8d4c72a8..75994de8b60 100644
--- a/doc/board/ti/j721e_evm.rst
+++ b/doc/board/ti/j721e_evm.rst
@@ -39,7 +39,7 @@ Boot Flow:
Boot flow is similar to that of AM65x SoC and extending it with remoteproc
support. Below is the pictorial representation of boot flow:
-.. image:: img/boot_diagram_j721e.svg
+.. kernel-figure:: img/boot_diagram_j721e.svg
:alt: Boot flow diagram
- Here DMSC acts as master and provides all the critical services. R5/A72
@@ -141,17 +141,17 @@ Image formats:
- tiboot3.bin
-.. image:: img/no_multi_cert_tiboot3.bin.svg
+.. kernel-figure:: img/no_multi_cert_tiboot3.bin.svg
:alt: tiboot3.bin image format
- tispl.bin
-.. image:: img/dm_tispl.bin.svg
+.. kernel-figure:: img/dm_tispl.bin.svg
:alt: tispl.bin image format
- sysfw.itb
-.. image:: img/sysfw.itb.svg
+.. kernel-figure:: img/sysfw.itb.svg
:alt: sysfw.itb image format
OSPI:
@@ -178,7 +178,7 @@ addresses.
Flash layout for OSPI:
-.. image:: img/ospi_sysfw.svg
+.. kernel-figure:: img/ospi_sysfw.svg
:alt: OSPI flash partition layout
R5 Memory Map:
diff --git a/doc/board/ti/j721s2_evm.rst b/doc/board/ti/j721s2_evm.rst
index 21683b90b1a..1257c5a3ae9 100644
--- a/doc/board/ti/j721s2_evm.rst
+++ b/doc/board/ti/j721s2_evm.rst
@@ -42,7 +42,7 @@ Boot Flow:
Below is the pictorial representation of boot flow:
-.. image:: img/boot_diagram_k3_current.svg
+.. kernel-figure:: img/boot_diagram_k3_current.svg
- On this platform, "TI Foundational Security" (TIFS) functions as the
security enclave master while "Device Manager" (DM), also known as the
@@ -152,11 +152,11 @@ Image formats:
- tiboot3.bin
-.. image:: img/multi_cert_tiboot3.bin.svg
+.. kernel-figure:: img/multi_cert_tiboot3.bin.svg
- tispl.bin
-.. image:: img/dm_tispl.bin.svg
+.. kernel-figure:: img/dm_tispl.bin.svg
R5 Memory Map:
--------------
diff --git a/doc/board/ti/j722s_evm.rst b/doc/board/ti/j722s_evm.rst
index 9c53fa50858..ec3254d9ae7 100644
--- a/doc/board/ti/j722s_evm.rst
+++ b/doc/board/ti/j722s_evm.rst
@@ -32,7 +32,7 @@ Boot Flow:
The bootflow is exactly the same as all SoCs in the am62xxx extended SoC
family. Below is the pictorial representation:
-.. image:: img/boot_diagram_k3_current.svg
+.. kernel-figure:: img/boot_diagram_k3_current.svg
:alt: Boot flow diagram
- Here TIFS acts as master and provides all the critical services. R5/A53
@@ -126,12 +126,12 @@ Image formats:
- tiboot3.bin
-.. image:: img/multi_cert_tiboot3.bin.svg
+.. kernel-figure:: img/multi_cert_tiboot3.bin.svg
:alt: tiboot3.bin image format
- tispl.bin
-.. image:: img/dm_tispl.bin.svg
+.. kernel-figure:: img/dm_tispl.bin.svg
:alt: tispl.bin image format
A53 SPL DDR Memory Layout
diff --git a/doc/board/ti/j784s4_evm.rst b/doc/board/ti/j784s4_evm.rst
index 22442874110..a6bb11b9a91 100644
--- a/doc/board/ti/j784s4_evm.rst
+++ b/doc/board/ti/j784s4_evm.rst
@@ -41,7 +41,7 @@ Boot Flow
---------
Below is the pictorial representation of boot flow:
-.. image:: img/boot_diagram_k3_current.svg
+.. kernel-figure:: img/boot_diagram_k3_current.svg
:alt: K3 boot flow
- On this platform, "TI Foundational Security" (TIFS) functions as the
@@ -158,12 +158,12 @@ Image formats
- tiboot3.bin
-.. image:: img/multi_cert_tiboot3.bin.svg
+.. kernel-figure:: img/multi_cert_tiboot3.bin.svg
:alt: tiboot3.bin format
- tispl.bin
-.. image:: img/dm_tispl.bin.svg
+.. kernel-figure:: img/dm_tispl.bin.svg
:alt: tispl.bin format
OSPI:
@@ -188,7 +188,7 @@ addresses.
Flash layout for OSPI NOR:
-.. image:: img/ospi_sysfw3.svg
+.. kernel-figure:: img/ospi_sysfw3.svg
:alt: OSPI NOR flash partition layout
R5 Memory Map
diff --git a/doc/board/ti/k3.rst b/doc/board/ti/k3.rst
index 01fb9411688..0b9a91bf6fa 100644
--- a/doc/board/ti/k3.rst
+++ b/doc/board/ti/k3.rst
@@ -61,7 +61,7 @@ boot media needed to load the binaries packaged inside `tiboot3.bin`,
including a 32bit U-Boot SPL, (called the wakeup SPL) that ROM will jump
to after it has finished loading everything into internal SRAM.
-.. image:: img/boot_flow_01.svg
+.. kernel-figure:: img/boot_flow_01.svg
:alt: Boot flow up to wakeup domain SPL
The wakeup SPL, running on a wakeup domain core, will initialize DDR and
@@ -71,7 +71,7 @@ application cores inside the main domain to initialize the main domain,
starting with Trusted Firmware-A (TF-A), before moving on to start
OP-TEE and the main domain's U-Boot SPL.
-.. image:: img/boot_flow_02.svg
+.. kernel-figure:: img/boot_flow_02.svg
:alt: Boot flow up to main domain SPL
The main domain's SPL, running on a 64bit application core, has
@@ -80,7 +80,7 @@ initialize even more peripherals needed to load in the `u-boot.img`
which loads more firmware into the micro-controller & wakeup domains and
finally prepare the main domain to run Linux.
-.. image:: img/boot_flow_03.svg
+.. kernel-figure:: img/boot_flow_03.svg
:alt: Complete boot flow up to Linux
This is the typical boot flow for all K3 based SoCs, however this flow
@@ -691,7 +691,7 @@ generation device.
The overall structure of this setup is in the following figure.
-.. image:: img/openocd-overview.svg
+.. kernel-figure:: img/openocd-overview.svg
:alt: Overview of OpenOCD setup.
.. note::
diff --git a/doc/develop/memory.rst b/doc/develop/memory.rst
index 5177229630d..d7f842f3367 100644
--- a/doc/develop/memory.rst
+++ b/doc/develop/memory.rst
@@ -69,7 +69,7 @@ SPL Flow
Prior to setting up of the DRAM, the stack, malloc is defined as below
possibly sitting on a smaller readily available memory (SRAM etc.):
- .. image:: pics/spl_before_reloc.svg
+ .. kernel-figure:: pics/spl_before_reloc.svg
:alt: contents of ready RAM before relocation in SPL
Please see CONFIG_SPL_EARLY_BSS if BSS initialization is needed prior
@@ -95,7 +95,7 @@ SPL Flow
The final environment is setup and the system RAM now looks like this:
- .. image:: pics/spl_after_reloc.svg
+ .. kernel-figure:: pics/spl_after_reloc.svg
:alt: contents of DRAM after relocation in SPL
Again stack and gd are an optional move and may still remain in the
diff --git a/doc/develop/trace.rst b/doc/develop/trace.rst
index d3c8628d124..417f138fea2 100644
--- a/doc/develop/trace.rst
+++ b/doc/develop/trace.rst
@@ -111,7 +111,7 @@ Finally run kernelshark to display it (note it only works with `.dat` files!):
Using this tool you can view the trace records and see the timestamp for each
function.
-.. image:: pics/kernelshark.png
+.. kernel-figure:: pics/kernelshark.png
:width: 800
:alt: Kernelshark showing function-trace records
@@ -144,7 +144,7 @@ There is a -f option available to select a function graph:
Again, you can use kernelshark or trace-cmd to look at the output. In this case
you will see the time taken by each function shown against its exit record.
-.. image:: pics/kernelshark_fg.png
+.. kernel-figure:: pics/kernelshark_fg.png
:width: 800
:alt: Kernelshark showing function-graph records
@@ -188,11 +188,11 @@ command:
You can load the .svg file into a viewer. If you use Chrome (and some other
programs) you can click around and zoom in and out.
-.. image:: pics/flamegraph.png
+.. kernel-figure:: pics/flamegraph.png
:width: 800
:alt: Chrome showing the flamegraph.pl output
-.. image:: pics/flamegraph_zoom.png
+.. kernel-figure:: pics/flamegraph_zoom.png
:width: 800
:alt: Chrome showing zooming into the flamegraph.pl output
@@ -209,7 +209,7 @@ Note that trace collection does slow down execution so the timings will be
inflated. They should be used to guide optimisation. For accurate boot timings,
use bootstage.
-.. image:: pics/flamegraph_timing.png
+.. kernel-figure:: pics/flamegraph_timing.png
:width: 800
:alt: Chrome showing flamegraph.pl output with timing
diff --git a/tools/patman/patman.rst b/tools/patman/patman.rst
index 549e203c254..44a97ac11a6 100644
--- a/tools/patman/patman.rst
+++ b/tools/patman/patman.rst
@@ -932,7 +932,7 @@ be sure to check out the help.
Here is a sample 'progress' view:
-.. image:: pics/patman.jpg
+.. kernel-figure:: pics/patman.jpg
:width: 800
:alt: Patman showing the progress view
--
2.34.1
More information about the U-Boot
mailing list