[PATCH v3 6/7] doc: document mkimage fatfs type and Qualcomm multi-DTB

[Simon Glass]

Hi Aswin,

On 2026-04-17T12:09:44, Aswin Murugan <aswin.murugan at oss.qualcomm.com> wrote:
> doc: document mkimage fatfs type and Qualcomm multi-DTB
>
> Update doc/mkimage.1 to document the new fatfs image type,
> the --fat-* long options, a fatfs entry in the CONFIGURATION
> section, and two usage examples.
>
> Add doc/board/qualcomm/multi_dtb.rst describing the
> Qualcomm FIT-based multi-DTB packaging workflow for
> Snapdragon platforms. The document covers:
> - FIT ITS configuration and compatible string matching
> - QCOM metadata binary format and identifier properties
> - Guidelines for adding new socver/boardrev entries
> - Step-by-step image creation using mkimage -T fatfs
>
> Update doc/board/qualcomm/index.rst to include the new
> multi_dtb page in the toctree.
>
> Signed-off-by: Aswin Murugan <aswin.murugan at oss.qualcomm.com>
>
> doc/board/qualcomm/index.rst     |   1 +
>  doc/board/qualcomm/multi_dtb.rst | 352 +++++++++++++++++++++++++++++++++++++++
>  doc/mkimage.1                    | 103 ++++++++++++
>  3 files changed, 456 insertions(+)

> diff --git a/doc/board/qualcomm/multi_dtb.rst b/doc/board/qualcomm/multi_dtb.rst
> @@ -0,0 +1,352 @@
> +       cp -rap <u-boot build dir>/dts/upstream/src/arm64/qcom/*.dtb* \
> +               fit_image/arch/arm64/boot/dts/qcom/

The text above refers to "Qualcomm Linux Kernel Tree" but the
placeholder says "u-boot build dir". Please change this to reference
the kernel build directory.

> diff --git a/doc/board/qualcomm/multi_dtb.rst b/doc/board/qualcomm/multi_dtb.rst
> @@ -0,0 +1,352 @@
> +1. **Install required tools**::
> +
> +       sudo apt-get install device-tree-compiler u-boot-tools mtools

Step 6 notes that dosfstools is also required for mkfs.vfat - please
add dosfstools to this install command.

> diff --git a/doc/board/qualcomm/multi_dtb.rst b/doc/board/qualcomm/multi_dtb.rst
> @@ -0,0 +1,352 @@
> +6. **Pack the FIT image into a FAT partition image using mkimage**
> +
> +   The `mkimage tool supports creating FAT filesystem images directly via
> +   the fatfs image type.
> +
> +       mkimage -T fatfs -d out/ fitimage.bin \

This code block is missing the RST literal-block marker, i.e. the text
before it should end with ::

> diff --git a/doc/mkimage.1 b/doc/mkimage.1
> @@ -903,10 +984,32 @@ of data storage.
> +.BR mkfs.vfat (8),
> +.BR mcopy (1),

The SEE ALSO entries should be in alphabetical order. Please swap
these two lines so mcopy comes before mkfs.vfat

Regards,
Simon