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