diff options
author | Bin Meng <bmeng.cn@gmail.com> | 2019-07-18 10:33:47 +0300 |
---|---|---|
committer | Tom Rini <trini@konsulko.com> | 2019-07-24 17:07:24 +0300 |
commit | f0e608bc691d9af94b7ae33d13ac431942638689 (patch) | |
tree | 05ea50ef5af59097c1aa19a874d60a222b5354c2 /doc/index.rst | |
parent | c8fe916c91a125492244f9d9126bc05efaa2320b (diff) | |
download | u-boot-f0e608bc691d9af94b7ae33d13ac431942638689.tar.xz |
doc: Add top-level description about U-Boot documentation
This updates the index.rst to add top-level description about
U-Boot documentation. Words are taken from Linux kernel docs
and modified for U-Boot.
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 | 22 |
1 files changed, 19 insertions, 3 deletions
diff --git a/doc/index.rst b/doc/index.rst index 1946d09227..3500e68556 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,8 +1,19 @@ .. SPDX-License-Identifier: GPL-2.0+ -####################### -U-Boot Developer Manual -####################### +.. _u-boot_doc: + +The U-Boot Documentation +======================== + +This is the top level of the U-Boot's documentation tree. U-Boot +documentation, like the U-Boot itself, is very much a work in progress; +that is especially true as we work to integrate our many scattered +documents into a coherent whole. Please note that improvements to the +documentation are welcome; join the U-Boot list at http://lists.denx.de +if you want to help out. + +.. toctree:: + :maxdepth: 2 U-Boot API documentation ------------------------ @@ -17,3 +28,8 @@ needed). :maxdepth: 2 api/index + +Indices and tables +================== + +* :ref:`genindex` |