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
  42 U-Boot API documentation
  43 ------------------------
  44
  45 These books get into the details of how specific U-Boot subsystems work
  46 from the point of view of a U-Boot developer.  Much of the information here
  47 is taken directly from the U-Boot source, with supplemental material added
  48 as needed (or at least as we managed to add it - probably *not* all that is
  49 needed).
  50
  51 .. toctree::
  52    :maxdepth: 2
  53
  54    api/index
  55
  56 Architecture-specific doc
  57 -------------------------
  58
  59 These books provide programming details about architecture-specific
  60 implementation.
  61
  62 .. toctree::
  63    :maxdepth: 2
  64
  65    arch/index
  66
  67 Board-specific doc
  68 ------------------
  69
  70 These books provide details about board-specific information. They are
  71 organized in a vendor subdirectory.
  72
  73 .. toctree::
  74    :maxdepth: 2
  75
  76    board/index
  77
  78 Android-specific doc
  79 --------------------
  80
  81 These books provide information about booting the Android OS from U-Boot,
  82 manipulating Android images from U-Boot shell and discusses other
  83 Android-specific features available in U-Boot.
  84
  85 .. toctree::
  86    :maxdepth: 2
  87
  88    android/index
  89
  90 Chromium OS-specific doc
  91 ------------------------
  92
  93 .. toctree::
  94    :maxdepth: 2
  95
  96    chromium/index
  97
  98 Indices and tables
  99 ==================
 100
 101 * :ref:`genindex`