FIT documentation link vs copy
v4 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
v3: remove duplicate entries, provide commit message
v4: cleanup: newlines, duplicated word, commit order
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, 22 insertions(+), 685 deletions(-)
Signature · 1 line
2.34.1
RFC v4 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 | 4 +- doc/usage/fit/source_file_format.rst | 682 +-------------------------- 2 files changed, 5 insertions(+), 681 deletions(-)
doc/usage/fit/index.rst +2 -2
@@ -4,8 +4,8 @@ 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 reads and boots. Documentation about FIT is available in +`the Flattened Image Tree project <https://fitspec.osfw.foundation/>`_. .. toctree:: :maxdepth: 1
doc/usage/fit/source_file_format.rst +3 -679
686 lines not on this page · raw message
Signature · 1 line
2.34.1
Re: [RFC v4 1/2] doc: Remove FIT documentation that is elsewhere
Quoted 10 lines · Sam Povilus
FIT documentation is now a separate project, instead of having a duplicate, we should point at the other project.
Signed-off-by Sam Povilus <[email protected]>--- doc/usage/fit/index.rst | 4 +- doc/usage/fit/source_file_format.rst | 682 +-------------------------- 2 files changed, 5 insertions(+), 681 deletions(-)
RFC v4 2/2 doc: add missing table of content links
In reply to Sam Povilusadd missing table of content links, make alphabetical
--- doc/usage/fit/index.rst | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-)
doc/usage/fit/index.rst +17 -4
@@ -10,10 +10,23 @@ images that it reads and boots. Documentation about FIT is available in .. toctree:: :maxdepth: 1 - source_file_format + beaglebone_vboot howto - x86-fit-boot + 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 + source_file_format + uefi + update3 + update_uboot verified-boot - beaglebone_vboot - overlay-fdt-boot + x86-fit-boot
Signature · 1 line
2.34.1
Re: [RFC v4 2/2] doc: add missing table of content links
Quoted 8 lines · Sam Povilus
add missing table of content links, make alphabetical
Signed-off-by Sam Povilus <[email protected]>--- doc/usage/fit/index.rst | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-)