[PATCH 0/2] 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(-)
Update documentation to remove un-needed curly braces.
Signed-off-by: Sam Povilus sam.povilus@amd.com --- doc/usage/fit/source_file_format.rst | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-)
diff --git a/doc/usage/fit/source_file_format.rst b/doc/usage/fit/source_file_format.rst index b2b1e42bd7..310225d839 100644 --- a/doc/usage/fit/source_file_format.rst +++ b/doc/usage/fit/source_file_format.rst @@ -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
Update fit documentation to clarify that FPGA images are vendor specific and opaque bitstreams.
Signed-off-by: Sam Povilus sam.povilus@amd.com --- doc/usage/fit/source_file_format.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/doc/usage/fit/source_file_format.rst b/doc/usage/fit/source_file_format.rst index 310225d839..7727ab77c5 100644 --- a/doc/usage/fit/source_file_format.rst +++ b/doc/usage/fit/source_file_format.rst @@ -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
Hi Sam,
On Tue, 4 Jun 2024 at 13:53, Sam Povilus sam.povilus@amd.com wrote:
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
Hi Sam,
On Tue, 4 Jun 2024 at 20:13, Simon Glass sjg@chromium.org wrote:
Hi Sam,
On Tue, 4 Jun 2024 at 13:53, Sam Povilus sam.povilus@amd.com wrote:
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?
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
Hi Simon,
On 6/5/24 5:52 PM, Simon Glass wrote:
Hi Sam,
On Tue, 4 Jun 2024 at 20:13, Simon Glass sjg@chromium.org wrote:
Hi Sam,
On Tue, 4 Jun 2024 at 13:53, Sam Povilus sam.povilus@amd.com wrote:
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/....
It requires the objects.inv file to be available, which seems to be the case.
Hope this helps, Cheers, Quentin
participants (3)
-
Quentin Schulz -
Sam Povilus -
Simon Glass