Skip to contentSkip to conversation

Cleanup fit documentation

PATCH In review Sam Povilus 3 participants 6 messages Jun 4, 2024 – Jun 6, 2024

lore
Share & tools
lore
#0 lore raw

cover Cleanup fit documentation

Sam Povilus (2):
doc: Remove extraneous curly braces
doc: add clarity to what a "fpga" image is

 doc/usage/fit/source_file_format.rst | 28 ++++++++++++++--------------
 1 file changed, 14 insertions(+), 14 deletions(-)
Signature · 1 line
2.34.1
#1 lore raw

PATCH 1/2 doc: Remove extraneous curly braces

Update documentation to remove un-needed curly braces.

---
 doc/usage/fit/source_file_format.rst | 28 ++++++++++++++--------------
 1 file changed, 14 insertions(+), 14 deletions(-)
doc/usage/fit/source_file_format.rst +14 -14
index b2b1e42bd7..310225d839 100644
@@ -192,13 +192,13 @@ type
     invalid               Invalid Image
     aisimage              Davinci AIS image
     atmelimage            ATMEL ROM-Boot Image
-    copro                 Coprocessor Image}
+    copro                 Coprocessor Image
     fdt_legacy            legacy Image with Flat Device Tree
     filesystem            Filesystem Image
     firmware              Firmware
-    firmware_ivt          Firmware with HABv4 IVT }
+    firmware_ivt          Firmware with HABv4 IVT
     flat_dt               Flat Device Tree
-    fpga                  FPGA Image }
+    fpga                  FPGA Image
     gpimage               TI Keystone SPL Image
     imx8image             NXP i.MX8 Boot Image
     imx8mimage            NXP i.MX8M Boot Image
@@ -207,31 +207,31 @@ type
     kernel_noload         Kernel Image (no loading done)
     kwbimage              Kirkwood Boot Image
     lpc32xximage          LPC32XX Boot Image
-    mtk_image             MediaTek BootROM loadable Image }
+    mtk_image             MediaTek BootROM loadable Image
     multi                 Multi-File Image
     mxsimage              Freescale MXS Boot Image
     omapimage             TI OMAP SPL With GP CH
     pblimage              Freescale PBL Boot Image
     pmmc                  TI Power Management Micro-Controller Firmware
     ramdisk               RAMDisk Image
-    rkimage               Rockchip Boot Image }
-    rksd                  Rockchip SD Boot Image }
-    rkspi                 Rockchip SPI Boot Image }
+    rkimage               Rockchip Boot Image
+    rksd                  Rockchip SD Boot Image
+    rkspi                 Rockchip SPI Boot Image
     script                Script
     socfpgaimage          Altera SoCFPGA CV/AV preloader
     socfpgaimage_v1       Altera SoCFPGA A10 preloader
-    spkgimage             Renesas SPKG Image }
+    spkgimage             Renesas SPKG Image
     standalone            Standalone Program
-    stm32image            STMicroelectronics STM32 Image }
-    sunxi_egon            Allwinner eGON Boot Image }
-    sunxi_toc0            Allwinner TOC0 Boot Image }
+    stm32image            STMicroelectronics STM32 Image
+    sunxi_egon            Allwinner eGON Boot Image
+    sunxi_toc0            Allwinner TOC0 Boot Image
     tee                   Trusted Execution Environment Image
     ublimage              Davinci UBL image
     vybridimage           Vybrid Boot Image
     x86_setup             x86 setup.bin
-    zynqimage             Xilinx Zynq Boot Image }
-    zynqmpbif             Xilinx ZynqMP Boot Image (bif) }
-    zynqmpimage           Xilinx ZynqMP Boot Image }
+    zynqimage             Xilinx Zynq Boot Image
+    zynqmpbif             Xilinx ZynqMP Boot Image (bif)
+    zynqmpimage           Xilinx ZynqMP Boot Image
     ====================  ==================
 
 compression
Signature · 1 line
2.34.1
#2 lore raw

PATCH 2/2 doc: add clarity to what a "fpga" image is

In reply to Sam Povilus

Update fit documentation to clarify that FPGA images are vendor specific and opaque bitstreams.

---
 doc/usage/fit/source_file_format.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
doc/usage/fit/source_file_format.rst +1 -1
index 310225d839..7727ab77c5 100644
@@ -198,7 +198,7 @@ type
     firmware              Firmware
     firmware_ivt          Firmware with HABv4 IVT
     flat_dt               Flat Device Tree
-    fpga                  FPGA Image
+    fpga                  FPGA Device Image (bitstream file, vendor specific)
     gpimage               TI Keystone SPL Image
     imx8image             NXP i.MX8 Boot Image
     imx8mimage            NXP i.MX8M Boot Image
Signature · 1 line
2.34.1
#3 lore raw
In reply to Sam Povilus

Hi Sam,

Quoted 7 lines · Sam Povilus

Sam Povilus (2):
doc: Remove extraneous curly braces
doc: add clarity to what a "fpga" image is

 doc/usage/fit/source_file_format.rst | 28 ++++++++++++++--------------
 1 file changed, 14 insertions(+), 14 deletions(-)

This is now at [1]. Could you please instead do a PR for that?

I am not sure yet the best way to incorporate or link the FIT spec from the U-Boot documentation. I suppose we could employ a script to sync it?

Regards,
Simon

[1] https://github.com/open-source-firmware/flat-image-tree

#4 lore raw

Hi Sam,

Quoted 9 lines · Simon Glass

Hi Sam,

Quoted 5 lines · Sam Povilus

Sam Povilus (2):
doc: Remove extraneous curly braces
doc: add clarity to what a "fpga" image is

Quoted 8 lines
Quoted 2 lines
 doc/usage/fit/source_file_format.rst | 28 ++++++++++++++--------------
 1 file changed, 14 insertions(+), 14 deletions(-)

This is now at [1]. Could you please instead do a PR for that?

I am not sure yet the best way to incorporate or link the FIT spec from the U-Boot documentation. I suppose we could employ a script to sync it?

Hmm actually it is at [2].

So perhaps we can just link to it and drop some of the files from U-Boot?

Regards,
Simon

[2] https://fitspec.osfw.foundation/

#5 lore raw

Hi Simon,

Quoted 21 lines · Simon Glass

Hi Sam,

Quoted 17 lines · Simon Glass

Hi Sam,

Quoted 7 lines · Sam Povilus

Sam Povilus (2):
doc: Remove extraneous curly braces
doc: add clarity to what a "fpga" image is

  doc/usage/fit/source_file_format.rst | 28 ++++++++++++++--------------
  1 file changed, 14 insertions(+), 14 deletions(-)

This is now at [1]. Could you please instead do a PR for that?

I am not sure yet the best way to incorporate or link the FIT spec from the U-Boot documentation. I suppose we could employ a script to sync it?

One can reference links from another Sphinx project thanks to intersphinx_mapping, c.f. https://git.yoctoproject.org/yocto-docs/tree/documentation/conf.py#n114 and https://git.yoctoproject.org/yocto-docs/tree/documentation/migration-guides/release-notes-5.0.rst#n196.

It requires the objects.inv file to be available, which seems to be the case.

Hope this helps,
Cheers,
Quentin