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 User-oriented documentation
  19 ---------------------------
  20
  21 The following manuals are written for *users* of the U-Boot - those who are
  22 trying to get it to work optimally on a given system.
  23
  24 .. toctree::
  25    :maxdepth: 2
  26
  27    build/index
  28    usage/index
  29
  30 Developer-oriented documentation
  31 --------------------------------
  32
  33 The following manuals are written for *developers* of the U-Boot - those who
  34 want to contribute to U-Boot.
  35
  36 .. toctree::
  37    :maxdepth: 2
  38
  39    develop/index
  40
  41 Unified Extensible Firmware (UEFI)
  42 ----------------------------------
  43
  44 U-Boot provides an implementation of the UEFI API allowing to run UEFI
  45 compliant software like Linux, GRUB, and iPXE. Furthermore U-Boot itself
  46 can be run an UEFI payload.
  47
  48 .. toctree::
  49    :maxdepth: 2
  50
  51    uefi/index
  52
  53 Driver-Model documentation
  54 --------------------------
  55
  56 The following holds information on the U-Boot device driver framework:
  57 driver-model, including the design details of itself and several driver
  58 subsystems.
  59
  60 .. toctree::
  61    :maxdepth: 2
  62
  63    driver-model/index
  64
  65 U-Boot API documentation
  66 ------------------------
  67
  68 These books get into the details of how specific U-Boot subsystems work
  69 from the point of view of a U-Boot developer.  Much of the information here
  70 is taken directly from the U-Boot source, with supplemental material added
  71 as needed (or at least as we managed to add it - probably *not* all that is
  72 needed).
  73
  74 .. toctree::
  75    :maxdepth: 2
  76
  77    api/index
  78
  79 Architecture-specific doc
  80 -------------------------
  81
  82 These books provide programming details about architecture-specific
  83 implementation.
  84
  85 .. toctree::
  86    :maxdepth: 2
  87
  88    arch/index
  89
  90 Board-specific doc
  91 ------------------
  92
  93 These books provide details about board-specific information. They are
  94 organized in a vendor subdirectory.
  95
  96 .. toctree::
  97    :maxdepth: 2
  98
  99    board/index
 100
 101 Android-specific doc
 102 --------------------
 103
 104 These books provide information about booting the Android OS from U-Boot,
 105 manipulating Android images from U-Boot shell and discusses other
 106 Android-specific features available in U-Boot.
 107
 108 .. toctree::
 109    :maxdepth: 2
 110
 111    android/index
 112
 113 Indices and tables
 114 ==================
 115
 116 * :ref:`genindex`