FIT documentation link vs copy
v2 cover FIT documentation link vs copy
I'm proposing linking the FIT documentation instead of double book keeping it, it does have the disadvantage of making it more difficult to see the documentation especially if offline.
v2: update table of contents instead of removing
Sam Povilus (2):
doc: Remove FIT documentation that is elsewhere
doc: add missing table of content links
doc/usage/fit/index.rst | 25 +- doc/usage/fit/source_file_format.rst | 682 +-------------------------- 2 files changed, 25 insertions(+), 682 deletions(-)
Signature · 1 line
2.34.1
RFC v2 1/2 doc: Remove FIT documentation that is elsewhere
FIT documentation is now a separate project, instead of having a duplicate, we should point at the other project.
--- doc/usage/fit/index.rst | 5 +- doc/usage/fit/source_file_format.rst | 682 +-------------------------- 2 files changed, 5 insertions(+), 682 deletions(-)
doc/usage/fit/index.rst +2 -3
@@ -4,13 +4,12 @@ Flat Image Tree (FIT) ===================== U-Boot uses Flat Image Tree (FIT) as a standard file format for packaging -images that it it reads and boots. Documentation about FIT is available at -doc/uImage.FIT +images that it it reads and boots. Documentation about FIT is available in +`the Flattened Image Tree project <https://fitspec.osfw.foundation/>`_. .. toctree:: :maxdepth: 1 - source_file_format howto x86-fit-boot signature
doc/usage/fit/source_file_format.rst +3 -679
686 lines not on this page · raw message
Signature · 1 line
2.34.1
RFC v2 2/2 doc: add missing table of content links
In reply to Sam Povilus--- doc/usage/fit/index.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+)
doc/usage/fit/index.rst +20 -0
@@ -16,3 +16,23 @@ images that it it reads and boots. Documentation about FIT is available in verified-boot beaglebone_vboot overlay-fdt-boot + beaglebone_vboot + howto + kernel_fdt + kernel_fdts_compressed + kernel + multi + multi_spl + multi-with-fpga + multi-with-loadables + overlay-fdt-boot + sec_firmware_ppa + signature + sign-configs + sign-images + uefi + update3 + update_uboot + verified-boot + x86-fit-boot +
Signature · 1 line
2.34.1
Re: [RFC v2 2/2] doc: add missing table of content links
Hi Sam,
Quoted 1 line · Sam Povilus
Please can you add a commit message?
Quoted 10 lines
Signed-off-by Sam Povilus <[email protected]>--- doc/usage/fit/index.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+)doc/usage/fit/index.rst +0
-0
doc/usage/fit/index.rst images that it it reads and boots. Documentation about FIT is available in · line 19
Quoted 4 lines
doc/usage/fit/index.rst +1
-0@@ -16,3 +16,23 @@ images that it it reads and boots. Documentation about FIT is available in verified-boot beaglebone_vboot overlay-fdt-boot + beaglebone_vboot
This seems to duplicate an entry above. Can you try 'make htmldocs' and check that it passes?
Quoted 20 lines
doc/usage/fit/index.rst +19
-1+ howto + kernel_fdt + kernel_fdts_compressed + kernel + multi + multi_spl + multi-with-fpga + multi-with-loadables + overlay-fdt-boot + sec_firmware_ppa + signature + sign-configs + sign-images + uefi + update3 + update_uboot + verified-boot + x86-fit-boot + --
Quoted 2 lines
2.34.1
Regards,
Simon