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 /doc/index.rst | |
| 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>
Diffstat (limited to 'doc/index.rst')
| -rw-r--r-- | doc/index.rst | 14 |
1 files changed, 11 insertions, 3 deletions
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 |