brain-hackers_pepepper-mirror/u-boot-brain
1
0
Fork 0
mirror of https://github.com/brain-hackers/u-boot-brain synced 2024-06-09 23:36:03 +09:00
Code Issues Projects Releases Wiki Activity

doc: Add top-level description about U-Boot documentation

Browse Source 
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>
This commit is contained in:
Bin Meng 2019-07-18 00:33:47 -07:00 committed by Tom Rini
parent c8fe916c91
commit f0e608bc69
1 changed files with 19 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/index.rst
View File

@ -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`