doc/index.rst

   1 .. SPDX-License-Identifier: GPL-2.0+
   2
   3 .. _u-boot_doc:
   4
   5 The U-Boot Documentation
   6 ========================
   7
   8 This is the top level of the U-Boot's documentation tree.  U-Boot
   9 documentation, like the U-Boot itself, is very much a work in progress;
  10 that is especially true as we work to integrate our many scattered
  11 documents into a coherent whole.  Please note that improvements to the
  12 documentation are welcome; join the U-Boot list at http://lists.denx.de
  13 if you want to help out.
  14
  15 .. toctree::
  16    :maxdepth: 2
  17
  18 Driver-Model documentation
  19 --------------------------
  20 The following holds information on the U-Boot device driver framework:
  21 driver-model, including the design details of itself and several driver
  22 subsystems.
  23
  24 .. toctree::
  25    :maxdepth: 2
  26
  27    driver-model/index
  28
  29 U-Boot API documentation
  30 ------------------------
  31
  32 These books get into the details of how specific U-Boot subsystems work
  33 from the point of view of a U-Boot developer.  Much of the information here
  34 is taken directly from the U-Boot source, with supplemental material added
  35 as needed (or at least as we managed to add it - probably *not* all that is
  36 needed).
  37
  38 .. toctree::
  39    :maxdepth: 2
  40
  41    api/index
  42
  43 Architecture-specific doc
  44 -------------------------
  45
  46 These books provide programming details about architecture-specific
  47 implementation.
  48
  49 .. toctree::
  50    :maxdepth: 2
  51
  52    arch/index
  53
  54 Board-specific doc
  55 ------------------
  56
  57 These books provide details about board-specific information. They are
  58 organized in a vendor subdirectory.
  59
  60 .. toctree::
  61    :maxdepth: 2
  62
  63    board/index
  64
  65 Indices and tables
  66 ==================
  67
  68 * :ref:`genindex`