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 U-Boot API documentation
  19 ------------------------
  20
  21 These books get into the details of how specific U-Boot subsystems work
  22 from the point of view of a U-Boot developer.  Much of the information here
  23 is taken directly from the U-Boot source, with supplemental material added
  24 as needed (or at least as we managed to add it - probably *not* all that is
  25 needed).
  26
  27 .. toctree::
  28    :maxdepth: 2
  29
  30    api/index
  31
  32 Indices and tables
  33 ==================
  34
  35 * :ref:`genindex`