diff mbox series

[U-Boot,02/50] doc: Add top-level description about U-Boot documentation

Message ID 1563435275-22326-3-git-send-email-bmeng.cn@gmail.com
State Accepted
Commit f0e608bc691d9af94b7ae33d13ac431942638689
Delegated to: Tom Rini
Headers show
Series doc: Shape into useful HTML docs | expand

Commit Message

Bin Meng July 18, 2019, 7:33 a.m. UTC 
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>
---

 doc/index.rst | 22 +++++++++++++++++++---
 1 file changed, 19 insertions(+), 3 deletions(-)
diff mbox series

Patch

diff --git a/doc/index.rst b/doc/index.rst
index 1946d09..3500e68 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`