summaryrefslogtreecommitdiff
path: root/doc/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/index.rst')
-rw-r--r--doc/index.rst69
1 files changed, 63 insertions, 6 deletions
diff --git a/doc/index.rst b/doc/index.rst
index 0353c10a4b..9ae2e167bc 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -1,11 +1,68 @@
.. 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
+
+Driver-Model documentation
+--------------------------
+The following holds information on the U-Boot device driver framework:
+driver-model, including the design details of itself and several driver
+subsystems.
+
+.. toctree::
+ :maxdepth: 2
+
+ driver-model/index
+
+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
+
+ api/index
+
+Architecture-specific doc
+-------------------------
+
+These books provide programming details about architecture-specific
+implementation.
.. toctree::
+ :maxdepth: 2
+
+ arch/index
+
+Board-specific doc
+------------------
+
+These books provide details about board-specific information. They are
+organized in a vendor subdirectory.
+
+.. toctree::
+ :maxdepth: 2
+
+ board/index
+
+Indices and tables
+==================
- efi
- linker_lists
- serial
+* :ref:`genindex`