From 61adb2d2474eb72ea05365ef81e5c6d7e5f61441 Mon Sep 17 00:00:00 2001 From: Simon Glass Date: Thu, 18 Mar 2021 20:25:13 +1300 Subject: 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 --- doc/develop/package/binman.rst | 1 + doc/develop/package/index.rst | 19 +++++++++++++++++++ 2 files changed, 20 insertions(+) create mode 120000 doc/develop/package/binman.rst create mode 100644 doc/develop/package/index.rst (limited to 'doc/develop/package') diff --git a/doc/develop/package/binman.rst b/doc/develop/package/binman.rst new file mode 120000 index 0000000000..2e26e84b7d --- /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 0000000000..9374be2e62 --- /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 -- cgit From fcae6682a7929abf88d9f0b756f9d5f9725e4d14 Mon Sep 17 00:00:00 2001 From: Simon Glass Date: Thu, 18 Mar 2021 20:25:17 +1300 Subject: binman: Update various pieces of the documentation A few sections are a little out of date now. Update them. Signed-off-by: Simon Glass --- doc/develop/package/entries.rst | 1 + 1 file changed, 1 insertion(+) create mode 120000 doc/develop/package/entries.rst (limited to 'doc/develop/package') diff --git a/doc/develop/package/entries.rst b/doc/develop/package/entries.rst new file mode 120000 index 0000000000..ecedcebaad --- /dev/null +++ b/doc/develop/package/entries.rst @@ -0,0 +1 @@ +../../../tools/binman/entries.rst \ No newline at end of file -- cgit