]> git.ipfire.org Git - thirdparty/u-boot.git/commitdiff
treewide: fix uImage.FIT document paths
authorDaniel Golle <daniel@makrotopia.org>
Fri, 27 Feb 2026 00:03:29 +0000 (00:03 +0000)
committerHeinrich Schuchardt <heinrich.schuchardt@canonical.com>
Fri, 27 Mar 2026 09:50:29 +0000 (10:50 +0100)
Commit 488445cefa1 ("doc: Move FIT into its own directory") moved the
documentation in doc/uImage.FIT to doc/usage/fit, subsequently all
documents and example sources have been converted to reStructuredText.

Fix (almost) all of the remaining occurrences of the old path and
filenames across the tree.

The exception is doc/uImage.FIT/command_syntax_extensions.txt which
apparently has been removed entirely, or at least I was unable to
locate where that document is now.

Signed-off-by: Daniel Golle <daniel@makrotopia.org>
13 files changed:
README
board/technexion/pico-imx7d/README.pico-imx7d_BL33
boot/Kconfig
doc/README.dfutftp
doc/README.odroid
doc/README.uniphier
doc/README.update
doc/board/qualcomm/board.rst
doc/develop/package/index.rst
doc/usage/fit/howto.rst
lib/ecdsa/Kconfig
lib/rsa/Kconfig
tools/image-host.c

diff --git a/README b/README
index 20a73bab802ca8d40d33ec6686840190e854ac1f..e2d49e2ebd39540791d0cb46c2a9d8097cc82786 100644 (file)
--- a/README
+++ b/README
@@ -1662,7 +1662,7 @@ New uImage format (FIT)
 Flexible and powerful format based on Flattened Image Tree -- FIT (similar
 to Flattened Device Tree). It allows the use of images with multiple
 components (several kernels, ramdisks, etc.), with contents protected by
-SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
+SHA1, MD5 or CRC32. More details are found in the doc/usage/fit directory.
 
 
 Old uImage format
index 1b346093b88dab334d57bebbb2a6a5de890ee5b7..9bf4b9907d3bb2ea7d74dc5e87b9180730245668 100644 (file)
@@ -41,4 +41,4 @@ fiptool_images. Run below command in ATF folder to generate FIP image.
 - Test
     Just boot up your board and wait for u-boot start up after ATF's log.
     For booting Linux in FIT image, please reference the FIT files in
-    u-boot doc/uImage.FIT/ folder.
+    u-boot doc/usage/fit/ folder.
index e5db165424a726662c4367b0f171be78249bb84e..ab31b8f40ed8e6ddb8a5e97ec32f0cf95da3f508 100644 (file)
@@ -335,7 +335,7 @@ config TPL_LOAD_FIT
             property will not be loaded. This limitation also applies to FPGA
             images with the correct "compatible" string.
          2. For FPGA images, the supported "compatible" list is in the
-            doc/uImage.FIT/source_file_format.txt.
+            doc/usage/fit/source_file_format.rst.
          3. FDTs are only loaded for images with an "os" property of "u-boot".
             "linux" images are also supported with Falcon boot mode.
 
index 1206507911761ea5832ac8b8aa2979e8195fcc59..b25f398ee2e012ca91b0b309d5af434d9404ce40 100644 (file)
@@ -94,7 +94,7 @@ FIT image format for download
 To create FIT image for download one should follow the update tftp README file
 (./doc/README.update) with one notable difference:
 
-The original snippet of ./doc/uImage.FIT/update_uboot.its
+The original snippet of ./doc/usage/fit/update_uboot.rst
 
        images {
                update@1 {
index 1090a0ea141292b54f1bcef765bde7090f269fe7..6eb7e67474dd00faa3cd65e9e50426812053f6a1 100644 (file)
@@ -152,7 +152,7 @@ Two for both, kernel with device tree support and also without it:
 If proper fdt file exists then it will be automatically loaded,
 so for old kernel types, please remove fdt file from boot partition.
 
-The third boot option for multi image support (more info: doc/uImage.FIT/)
+The third boot option for multi image support (more info: doc/usage/fit/)
 - boot_fit - for binary file: "Image.itb"
 
 Default boot command: "autoboot"
index 9f72cfa67b51b8c12366bb96f05b9f44a8596880..6f373aa2a6cd726d3f5b38b54eb9a1e7ca817d32 100644 (file)
@@ -112,7 +112,7 @@ Verified Boot
 
 U-Boot supports an image verification method called "Verified Boot".
 This is a brief tutorial to utilize this feature for the UniPhier platform.
-You will find details documents in the doc/uImage.FIT directory.
+You will find details documents in the doc/usage/fit directory.
 
 Here, we take LD20 reference board for example, but it should work for any
 other boards including 32 bit SoCs.
index bf4379279e20fb35a8254516eefdf9ce96d52a3d..f16b2d23af185d3307ed367d04133220b1b426e9 100644 (file)
@@ -48,14 +48,14 @@ The auto-update feature uses the following configuration knobs:
 Since the update file is in FIT format, it is created from an *.its file using
 the mkimage tool. dtc tool with support for binary includes, e.g. in version
 1.2.0 or later, must also be available on the system where the update file is
-to be prepared. Refer to the doc/uImage.FIT/ directory for more details on FIT
+to be prepared. Refer to the doc/usage/fit/ directory for more details on FIT
 images.
 
 
 Example .its files
 ------------------
 
-- doc/uImage.FIT/update_uboot.its
+- doc/usage/fit/update_uboot.rst
 
   A simple example that can be used to create an update file for automatically
   replacing U-Boot image on a system.
@@ -83,7 +83,7 @@ Example .its files
   where the update will be placed is correct. Making mistake here and
   attempting the auto-update can render the system unusable.
 
-- doc/uImage.FIT/update3.its
+- doc/usage/fit/update3.rst
 
   An example containing three updates. It can be used to update Linux kernel,
   ramdisk and FDT blob stored in Flash. The procedure for preparing the update
index e5dbc9816b9ffabb13322b4a20a512746b5af03a..eb800f8c535a214ee0cdf4202c62725f3891d349 100644 (file)
@@ -27,7 +27,7 @@ We will build ``u-boot-nodtb.bin`` from the u-boot source tree.
 
 Generate FIT image (optional)
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-See doc/uImage.FIT for more details
+See doc/usage/fit for more details
 
 Pack android boot image
 ^^^^^^^^^^^^^^^^^^^^^^^
index 4f448313f95cfa0e125951c2d91d012053ef9ffd..ff4c1882cbd21be0976749d55541824400217d57 100644 (file)
@@ -5,7 +5,7 @@ Package U-Boot
 
 U-Boot uses Flat Image Tree (FIT) as a standard file format for packaging
 images that it reads and boots. Documentation about FIT is available at
-doc/uImage.FIT
+doc/usage/fit
 
 U-Boot also provides binman for cases not covered by FIT. Examples include
 initial execution (since FIT itself does not have an executable header) and
index 675c9aa5bb0faf570d373936198a7a4943d84563..9c8d86e50beb5fc10e69bddd50de84e92416cc2a 100644 (file)
@@ -157,7 +157,7 @@ development host is to be booted old-style (non-FDT) by U-Boot on an embedded
 target. Assume that the outcome of the build is vmlinux.bin.gz, a file which
 contains a gzip-compressed PPC Linux kernel (the only data file in this case).
 The uImage can be produced using the image source file
-doc/uImage.FIT/kernel.its (note that kernel.its assumes that vmlinux.bin.gz is
+doc/usage/fit/kernel.rst (note that kernel.its assumes that vmlinux.bin.gz is
 in the current working directory; if desired, an alternative path can be
 specified in the kernel.its file). Here's how to create the image and inspect
 its contents:
@@ -269,7 +269,7 @@ Example 2 -- new-style (FDT) kernel booting
 Consider another simple scenario, where a PPC Linux kernel is to be booted
 new-style, i.e., with a FDT blob. In this case there are two prerequisite data
 files: vmlinux.bin.gz (Linux kernel) and target.dtb (FDT blob). The uImage can
-be produced using image source file doc/uImage.FIT/kernel_fdt.its like this
+be produced using image source file doc/usage/fit/kernel_fdt.rst like this
 (note again, that both prerequisite data files are assumed to be present in
 the current working directory -- image source file kernel_fdt.its can be
 modified to take the files from some other location if needed):
index 5c3d67d8144b48860154cac84fe8aa38e0df2547..ca13b6bfa1f0e578de34011c85d419266df39ce9 100644 (file)
@@ -5,7 +5,7 @@ config ECDSA
          This enables the ECDSA (elliptic curve signature) algorithm for FIT
          image verification in U-Boot. The ECDSA algorithm is implemented
          using the driver model, so CONFIG_DM is required by this library.
-         See doc/uImage.FIT/signature.txt for more details.
+         See doc/usage/fit/signature.rst for more details.
          ECDSA is enabled for mkimage regardless of this option.
 
 if ECDSA
index 1a763149c0561247712070017fd5fe8754f9fde9..12a71c3df6f2f89dcc91032b2f4102dcb7d7262d 100644 (file)
@@ -6,7 +6,7 @@ config RSA
        help
          RSA support. This enables the RSA algorithm used for FIT image
          verification in U-Boot.
-         See doc/uImage.FIT/signature.txt for more details.
+         See doc/usage/fit/signature.rst for more details.
          The Modular Exponentiation algorithm in RSA is implemented using
          driver model. So CONFIG_DM needs to be enabled by default for this
          library to function.
@@ -88,7 +88,7 @@ config RSA_SOFTWARE_EXP
          Enables driver for modular exponentiation in software. This is a RSA
          algorithm used in FIT image verification. It required RSA Key as
          input.
-         See doc/uImage.FIT/signature.txt for more details.
+         See doc/usage/fit/signature.rst for more details.
 
 config RSA_FREESCALE_EXP
        bool "Enable RSA Modular Exponentiation with FSL crypto accelerator"
index 48d69191c92150fe45a893e11ddffaf03e6bf031..8b550af0dc172688b3985820357b5bfc085590f8 100644 (file)
@@ -650,7 +650,7 @@ int fit_image_cipher_data(const char *keydir, void *keydest,
  *     |- algo = "sha1"
  *     |- value = sha1(data)
  *
- * For signature details, please see doc/uImage.FIT/signature.txt
+ * For signature details, please see doc/usage/fit/signature.rst
  *
  * @keydir     Directory containing *.key and *.crt files (or NULL)
  * @keydest    FDT Blob to write public keys into (NULL if none)