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