diff options
author | Bin Meng <bmeng.cn@gmail.com> | 2019-07-18 10:33:46 +0300 |
---|---|---|
committer | Tom Rini <trini@konsulko.com> | 2019-07-24 17:07:24 +0300 |
commit | c8fe916c91a125492244f9d9126bc05efaa2320b (patch) | |
tree | 53f6b94a97139d554b3198525160c92e40d18fb5 | |
parent | fe4243870df152f839f88e5aa355f53cfba0a866 (diff) | |
download | u-boot-c8fe916c91a125492244f9d9126bc05efaa2320b.tar.xz |
doc: Move existing rst files into api sub-directory
Currently the Sphinx doc only contains API descriptions of several
U-Boot subsystems. For future extension, group these existing docs
into an API sub-directory.
Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
-rw-r--r-- | doc/api/efi.rst (renamed from doc/efi.rst) | 0 | ||||
-rw-r--r-- | doc/api/index.rst | 11 | ||||
-rw-r--r-- | doc/api/linker_lists.rst (renamed from doc/linker_lists.rst) | 0 | ||||
-rw-r--r-- | doc/api/serial.rst (renamed from doc/serial.rst) | 0 | ||||
-rw-r--r-- | doc/index.rst | 14 |
5 files changed, 22 insertions, 3 deletions
diff --git a/doc/efi.rst b/doc/api/efi.rst index 39e2dbae0b..39e2dbae0b 100644 --- a/doc/efi.rst +++ b/doc/api/efi.rst diff --git a/doc/api/index.rst b/doc/api/index.rst new file mode 100644 index 0000000000..d484c066c5 --- /dev/null +++ b/doc/api/index.rst @@ -0,0 +1,11 @@ +.. SPDX-License-Identifier: GPL-2.0+ + +U-Boot API documentation +======================== + +.. toctree:: + :maxdepth: 2 + + efi + linker_lists + serial diff --git a/doc/linker_lists.rst b/doc/api/linker_lists.rst index 72f514e0ac..72f514e0ac 100644 --- a/doc/linker_lists.rst +++ b/doc/api/linker_lists.rst diff --git a/doc/serial.rst b/doc/api/serial.rst index ed34e592a4..ed34e592a4 100644 --- a/doc/serial.rst +++ b/doc/api/serial.rst diff --git a/doc/index.rst b/doc/index.rst index 0353c10a4b..1946d09227 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -4,8 +4,16 @@ U-Boot Developer Manual ####################### +U-Boot API documentation +------------------------ + +These books get into the details of how specific U-Boot subsystems work +from the point of view of a U-Boot developer. Much of the information here +is taken directly from the U-Boot source, with supplemental material added +as needed (or at least as we managed to add it - probably *not* all that is +needed). + .. toctree:: + :maxdepth: 2 - efi - linker_lists - serial + api/index |