diff options
| author | Simon Glass <sjg@chromium.org> | 2021-03-18 20:25:13 +1300 |
|---|---|---|
| committer | Simon Glass <sjg@chromium.org> | 2021-03-26 17:03:10 +1300 |
| commit | 61adb2d2474eb72ea05365ef81e5c6d7e5f61441 (patch) | |
| tree | 809ddf2cb7446b9178e3a9d4831a3e6f1ce0c015 /doc | |
| parent | 5ce319133b2364e3283c3cde7a269681ff8431af (diff) | |
| download | u-boot-61adb2d2474eb72ea05365ef81e5c6d7e5f61441.zip u-boot-61adb2d2474eb72ea05365ef81e5c6d7e5f61441.tar.gz u-boot-61adb2d2474eb72ea05365ef81e5c6d7e5f61441.tar.bz2 | |
binman: doc: Add documentation to htmldocs
Add a link to binman's documentation and adjust the files so that it is
accessible. Use the name README.rst so it is easy to discover when binman
is installed without U-Boot.
Signed-off-by: Simon Glass <sjg@chromium.org>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/develop/index.rst | 8 | ||||
| l--------- | doc/develop/package/binman.rst | 1 | ||||
| -rw-r--r-- | doc/develop/package/index.rst | 19 | ||||
| -rw-r--r-- | doc/usage/fit.rst | 8 | ||||
| -rw-r--r-- | doc/usage/index.rst | 1 |
5 files changed, 37 insertions, 0 deletions
diff --git a/doc/develop/index.rst b/doc/develop/index.rst index 444df67..3edffbc 100644 --- a/doc/develop/index.rst +++ b/doc/develop/index.rst @@ -26,6 +26,14 @@ Debugging crash_dumps trace +Packaging +--------- + +.. toctree:: + :maxdepth: 1 + + package/index + Testing ------- diff --git a/doc/develop/package/binman.rst b/doc/develop/package/binman.rst new file mode 120000 index 0000000..2e26e84 --- /dev/null +++ b/doc/develop/package/binman.rst @@ -0,0 +1 @@ +../../../tools/binman/binman.rst
\ No newline at end of file diff --git a/doc/develop/package/index.rst b/doc/develop/package/index.rst new file mode 100644 index 0000000..9374be2 --- /dev/null +++ b/doc/develop/package/index.rst @@ -0,0 +1,19 @@ +.. SPDX-License-Identifier: GPL-2.0+ + +Package U-Boot +============== + +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 + +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 +dealing with device boundaries, such as the read-only/read-write separation in +SPI flash. + + +.. toctree:: + :maxdepth: 2 + + binman diff --git a/doc/usage/fit.rst b/doc/usage/fit.rst new file mode 100644 index 0000000..7037434 --- /dev/null +++ b/doc/usage/fit.rst @@ -0,0 +1,8 @@ +.. SPDX-License-Identifier: GPL-2.0+ + +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 diff --git a/doc/usage/index.rst b/doc/usage/index.rst index 637b73c..35c515f 100644 --- a/doc/usage/index.rst +++ b/doc/usage/index.rst @@ -5,6 +5,7 @@ Use U-Boot :maxdepth: 1 fdt_overlays + fit netconsole partitions |