[U-Boot] [RFC PATCH 2/9] doc: Add top-level description about U-Boot documentation
Bin Meng
bmeng.cn at gmail.com
Tue Jul 16 16:42:47 UTC 2019
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 at gmail.com>
---
doc/index.rst | 22 +++++++++++++++++++---
1 file changed, 19 insertions(+), 3 deletions(-)
diff --git a/doc/index.rst b/doc/index.rst
index 1946d09..cfcf1dd 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`
--
2.7.4
More information about the U-Boot
mailing list